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.
| status | Meaning |
|---|---|
1 | Pending: the first payment hasn't been made. |
2 | Active. |
3 | Cancelled. |
4 | Charged outside its cycle. |
5 | Payment failed: renewals gave up. A card update brings it back. |
6 | Paused: never billed until resumed. |
Errors
401 | The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs. |