v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB
Plans

List plans for a product

Retrieves the plans belonging to a product, paginated in-memory. Returns SDK-shaped plans with money serialized to wire units and unsupported plan types normalised to "recurring".

get/v1/sdk/products/{productRef}/plans

Path parameters

productRefstring required
Example:prd_1A2B3C4D

Product reference or ID

Query parameters

limitnumber

Max results (default 50)

offsetnumber

Pagination offset (default 0)

Response

Plans retrieved successfully

limitnumber
offsetnumber
totalnumber

Total number of plans for the product

Example response

{
  "plans": [
    {
      "billingCycle": "monthly",
      "billingModel": "pre-paid",
      "creditsPerUnit": 1,
      "currency": "USD",
      "currencySymbol": "$",
      "description": "Best for teams getting started",
      "freeUnits": 100,
      "isActive": true,
      "limit": 10000,
      "measures": "requests",
      "meterRef": "mtr_1A2B3C4D",
      "name": "Starter",
      "price": 2999,
      "pricingOptions": [
        {
          "basePrice": 1999,
          "currency": "USD",
          "default": true,
          "price": 2999,
          "setupFee": 500
        }
      ],
      "reference": "pln_1A2B3C4D",
      "requiresPayment": true,
      "setupFee": 500,
      "status": "active",
      "trialDays": 14,
      "type": "recurring"
    }
  ]
}