Get plan group by ID | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.plans.getGroupById("planGroupId");
}
main();

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "organizationId": "7b9e1f2a-4d3c-4f8a-9a2e-1d2f3b4c5d6e",
  "name": "Enterprise Subscription Plans",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "description": "A collection of subscription plans tailored for enterprise clients.",
  "plans": [
    {
      "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "organizationId": "7b9e1f2a-4d3c-4f8a-9a2e-1d2f3b4c5d6e",
      "planGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Basic Enterprise Plan",
      "type": "flat",
      "pricing": {
        "PricePoints": {
          "USD": {
            "unitPrice": 9900,
            "tiers": []
          }
        },
        "billingFrequency": "monthly",
        "billingFrequencyCustomMonths": 1.1
      },
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "description": "Entry-level plan with essential features for small teams.",
      "nextPlanId": "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
      "prevPlanId": null,
      "planProducts": [
        {
          "id": "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f90",
          "organizationId": "7b9e1f2a-4d3c-4f8a-9a2e-1d2f3b4c5d6e",
          "planId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "productId": "9f8e7d6c-5b4a-3920-1f2e-3d4c5b6a7e8f",
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z",
          "product": {
            "id": "9f8e7d6c-5b4a-3920-1f2e-3d4c5b6a7e8f",
            "organizationId": "7b9e1f2a-4d3c-4f8a-9a2e-1d2f3b4c5d6e",
            "name": "Enterprise Basic Agent",
            "type": "agent",
            "active": true,
            "externalId": "EXT-12345",
            "displayId": "ENT-BASIC-001",
            "description": "Agent product for basic enterprise plan.",
            "productCode": "ENT-BASIC-AGT",
            "ProductAttribute": [
              {
                "name": "Standard Support",
                "active": true,
                "pricing": {
                  "taxable": true,
                  "chargeType": "oneTime",
                  "pricingModel": "PerUnit",
                  "billingFrequency": "monthly",
                  "pricePoints": {
                    "USD": {
                      "unitPrice": 1000,
                      "minQuantity": 1,
                      "includedQuantity": 0,
                      "tiers": []
                    }
                  },
                  "eventName": "support_event",
                  "creditCost": 10
                }
              }
            ],
            "metadata": {
              "category": "support",
              "region": "US"
            },
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          },
          "planProductAttribute": [
            {
              "id": "5e6f7a8b-9c0d-1e2f-3a4b-5c6d7e8f9012",
              "organizationId": "7b9e1f2a-4d3c-4f8a-9a2e-1d2f3b4c5d6e",
              "planProductId": "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f90",
              "productAttributeId": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
              "pricing": {
                "USD": {
                  "unitPrice": 1000,
                  "minQuantity": 1,
                  "includedQuantity": 0,
                  "tiers": []
                }
              },
              "createdAt": "2024-01-15T09:30:00Z",
              "updatedAt": "2024-01-15T09:30:00Z"
            }
          ]
        }
      ]
    }
  ]
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

planGroupIdstringRequiredformat: "uuid"

The ID of the plan group

Response

Success response

idstringformat: "uuid"

The unique identifier of the plan group

organizationIdstringformat: "uuid"

The organization ID that owns this plan group

namestring

The name of the plan group

createdAtdatetime

When the plan group was created

updatedAtdatetime

When the plan group was last updated

descriptionstring or null

The description of the plan group

planslist of objects or null

The plans included in this plan group

Authentication

Path parameters

Response

Errors