Skip to content
API referenceAPI v1admin-sdk 1.1.52Search docs⌘K
Subscriptions · List subscriptions
API reference / Subscriptions

List subscriptions

GET/api/v1/billing_subscriptionsbilling:write

The merchant's subscriptions.

Query parameters

pageinteger

Page number, from 1.

page_sizeinteger

Items per page.

orderstring

Sort, e.g. id desc for newest first.

statusinteger

Only this status.

billing_plan_idinteger

Only this plan's subscribers.

Headers

Authorizationheaderrequired

Bearer with your secret key, or the merchant's OAuth token.

Returns

entries and pagination.

statusMeaning
1Pending: the first payment hasn't been made.
2Active.
3Cancelled.
4Charged outside its cycle.
5Payment failed: renewals gave up. A card update brings it back.
6Paused: never billed until resumed.

Errors

401The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs.