Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Customer Portal

List customer subscriptions

Returns all subscriptions for the customer with plan details.

get/api/portal/customers/{externalId}/subscriptions

Path parameters

externalIdstring required

Customer external ID

Response

List of subscriptions with plan info

idstring required
externalIdstring
customerIdstring required
planIdstring required
previousPlanIdstring
status'ACTIVE' | 'PAST_DUE' | 'CANCELED' | 'TRIALING' | 'PAUSED' required
currencystring required
billingTiming'IN_ADVANCE' | 'IN_ARREARS' required
currentPeriodStartstring required
currentPeriodEndstring required
cancelAtstring
canceledAtstring
trialStartstring
trialEndstring
startedAtstring required
metadataobject
createdAtstring required
updatedAtstring required

Example response

[
  {
    "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"
    }
  }
]