Sign in

v2

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

List subscriptions

Retrieve a paginated list of subscriptions. Supports filtering by status, customer, and plan.

get/api/subscriptions

Query parameters

statusstring

Filter by status (ACTIVE, TRIALING, PAUSED, CANCELED)

customerIdstring

Filter by customer ID

planIdstring

Filter by plan ID

pagenumber
limitnumber

Response

Paginated list of subscriptions with customer and plan details

Example response

{
  "data": [
    {
      "id": "clx1234567890",
      "externalId": "ext_sub_123",
      "customerId": "clxcust123",
      "planId": "clxplan123",
      "status": "ACTIVE",
      "currency": "USD",
      "billingTiming": "IN_ARREARS",
      "customer": {
        "id": "clx1234567890",
        "name": "Jane Doe",
        "email": "jane@example.com"
      },
      "plan": {
        "id": "clxplan123",
        "name": "Premium Monthly",
        "billingInterval": "MONTHLY"
      }
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "limit": 20,
    "totalPages": 8
  }
}