Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Plans

List all plans

Retrieve all billing plans with their prices. Optionally filter by active status.

get/api/plans

Query parameters

isActiveboolean

Filter by active status

Response

List of plans with prices

idstring required
namestring required
codestring required
descriptionstring
billingInterval'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY' required
featuresstring[]
isActiveboolean required
billingTiming'IN_ADVANCE' | 'IN_ARREARS' required
minimumCommitmentstring

Minimum commitment amount

createdAtstring required
updatedAtstring required

Example response

[
  {
    "id": "clx1234567890",
    "name": "Premium Monthly",
    "code": "premium_monthly",
    "description": "Premium plan with all features",
    "billingInterval": "MONTHLY",
    "features": [
      "Unlimited users",
      "Priority support"
    ],
    "isActive": true,
    "billingTiming": "IN_ARREARS",
    "minimumCommitment": "100.0000",
    "prices": [
      {
        "id": "clx1234567890",
        "planId": "clxplan123",
        "currency": "USD",
        "amount": "49.9900",
        "isActive": true
      }
    ]
  }
]