Sign in

v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
Subscription

List subscriptions

This endpoint returns a list of all subscriptions for an account as a paginated list, ordered starting from the most recently created subscription. For a full discussion of the subscription resource, see Subscription.

Subscriptions can be filtered for a specific customer by using either the customer_id or external_customer_id query parameters. To filter subscriptions for multiple customers, use the customer_id[] or external_customer_id[] query parameters.

Subscriptions can be filtered by status using the status query parameter (one of active, ended, or upcoming). To filter for multiple statuses in a single request, use the status[] query parameter, e.g. status[]=active&status[]=ended.

get/subscriptions

Query parameters

limitinteger

The number of items to fetch. Defaults to 20.

cursorstring nullable

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

customer_idstring nullable
customer_id[]string[] nullable
external_customer_idstring nullable
external_customer_id[]string[] nullable
plan_idstring nullable
external_plan_idstring nullable
status'active' | 'ended' | 'upcoming' nullable
status[]string[] nullable
created_at[gte]string date-time nullable
created_at[gt]string date-time nullable
created_at[lt]string date-time nullable
created_at[lte]string date-time nullable

Response

OK