Skip to main content
GET
/
v1
/
sdk
/
products
/
{productRef}
/
plans
List plans for a product
curl --request GET \
  --url https://api.example.com/v1/sdk/products/{productRef}/plans
{
  "plans": [
    {
      "type": "recurring",
      "reference": "pln_1A2B3C4D",
      "price": 2999,
      "currency": "USD",
      "requiresPayment": true,
      "isActive": true,
      "status": "active",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "meterRef": "mtr_1A2B3C4D",
      "name": "Starter",
      "description": "Best for teams getting started",
      "currencySymbol": "$",
      "freeUnits": 100,
      "setupFee": 500,
      "trialDays": 14,
      "billingCycle": "monthly",
      "billingModel": "pre-paid",
      "creditsPerUnit": 1,
      "measures": "requests",
      "limit": 10000,
      "rolloverUnusedUnits": false,
      "limits": {},
      "features": {},
      "maxActiveUsers": 123,
      "accessExpiryDays": 123
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Path Parameters

productRef
string
required

Product reference or ID

Query Parameters

limit
number
offset
number

Response

Plans retrieved successfully

plans
object[]
total
number

Total number of plans for the product

limit
number
offset
number