Get plans for a plan group | Paid

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Premium Plan",
    "type": "flat",
    "pricing": {
      "PricePoints": {
        "USD": {
          "unitPrice": 19900,
          "tiers": []
        }
      },
      "billingFrequency": "monthly",
      "billingFrequencyCustomMonths": 1.1
    },
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-04-10T12:00:00Z",
    "features": [
      {
        "productName": "Cloud Storage",
        "attributeName": "Storage Limit",
        "pricing": {
          "unitPrice": 0,
          "currency": "USD"
        }
      }
    ],
    "description": "Access to all premium features with priority support",
    "nextPlanId": "7b9c9f64-1234-4562-b3fc-2c963f66b123",
    "prevPlanId": "1a2b3c64-5717-4562-b3fc-2c963f66a789"
  }
]

Retrieves all plans in a plan group with their features (product-attribute pairs)

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

namestring

The name of the plan

typeenum

The type of plan (flat for fixed pricing, usage for usage-based, credit for prepaid credits)

Allowed values:

pricingobject

The pricing configuration for a plan. Uses the same PricePoints structure as product pricing.

createdAtdatetime

When the plan was created

updatedAtdatetime

When the plan was last updated

featureslist of objects

The features (product-attribute pairs) included in this plan

descriptionstring or null

The description of the plan

nextPlanIdstring or nullformat: "uuid"

The ID of the next plan in the sequence

prevPlanIdstring or nullformat: "uuid"

The ID of the previous plan in the sequence

Authentication

Path parameters

Response

Errors