Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Customers

List customer subscriptions

Lists all subscriptions for a customer.

get/api/v1/customers/{customerIdOrKey}/subscriptions

Path parameters

string required

ULID (Universally Unique Lexicographically Sortable Identifier).

OR
string required

ExternalKey is a looser version of key.

Example:01G65Z755AFWAKHE12NY0CQ9FH

Query parameters

statusSubscriptionStatus[]
order'ASC' | 'DESC'

The order direction.

The order direction.

orderBy'activeFrom' | 'activeTo'

Order by options for customer subscriptions.

The order by field.

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

Response

The request has succeeded.

totalCountinteger required

The total number of items.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

Example response

{
  "totalCount": 500,
  "page": 1,
  "pageSize": 100,
  "items": [
    {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "metadata": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      },
      "createdAt": "2024-01-01T01:01:01.001Z",
      "updatedAt": "2024-01-01T01:01:01.001Z",
      "deletedAt": "2024-01-01T01:01:01.001Z",
      "activeFrom": "2023-01-01T01:01:01.001Z",
      "activeTo": "2023-01-01T01:01:01.001Z",
      "annotations": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      },
      "customerId": "01G65Z755AFWAKHE12NY0CQ9FH",
      "plan": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH"
      },
      "currency": "USD",
      "billingCadence": "P1M",
      "billingAnchor": "2023-01-01T01:01:01.001Z"
    }
  ]
}