Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Subscriptions

List all subscriptions

Returns a list of all subscription IDs.

get/subscriptions

Query parameters

accountIdstring
Example:abCdE1FGH2Hij3KLMnOpqR

Filter subscriptions by the associated account ID.

beginstring date
Example:2025-01-01

Specify the beginning of a date range in yyyy-mm-dd format.

endstring date
Example:2025-12-31

Specify the end of a date range in yyyy-mm-dd format.

event'canceled' | 'charged' | 'created' | 'deactivated' | 'trialended' | 'trialstarted'
Example:created

Specify the event type to filter results. Valid values include canceled, charged, created, deactivated, trialended, or trialstarted.

Must be used with the begin and end parameters.

productsstring
Example:product-12345

Filter subscriptions by specific product IDs.

scope'all' | 'live' | 'test'
Example:live

Specify the scope to filter by test or live subscriptions. If not provided, both live and test subscriptions are returned by default.

status'active' | 'canceled' | 'deactivated' | 'overdue' | 'trial'
Example:active

Specify the subscription status to filter results. Valid values include active, canceled, deactivated, overdue, or trial.

pageinteger
Example:1

Specify the page number of results to retrieve. Defaults to 1 if not provided.

limitinteger
Example:50

Specify the maximum number of results per page. Defaults to 50 if not provided.

Response

OK

actionstring

The action performed by the API call.

resultstring

The result of the API request (e.g., success or error).

pageinteger

Current page number. Only returned when the request included query parameters.

limitinteger

Maximum number of results per page. Only returned when the request included query parameters.

nextPageinteger nullable

The next page number of results, or null if no additional pages are available.

totalinteger

Total number of subscriptions matching the filter. Only returned when the request included query parameters.

Example response

{
  "action": "subscription.lookup",
  "result": "success",
  "page": 1,
  "limit": 50,
  "nextPage": 3,
  "total": 3,
  "subscriptions": [
    "1abc2DE_FGhIjKLm3NoPQR",
    "a12cD2-eFGhIjKLXn4OPq",
    "12cDfgHIjKLmNOPqRs_tUVa"
  ]
}