Subscriptions
Retrieve a subscription
Fetches one subscription by id, including its current period, price and renewal state.
GET/v1/subscriptions/{subscription_id}
Parameters
| Parameter | Description |
|---|---|
| subscription_idstring · pathrequired | No description in the spec. |
| expandstring | null · queryoptional | At most 256 characters. |
Returns
The subscription object. A subscription belonging to the other mode, or to another account, is a 404 rather than a 403, so no id existence leaks across tenants.
Read renewal_state, not just status, when you need to know what happens at the period boundary: a subscription can be active today and set to cancel or paused at renewal.
Test it
Read the same subscription in the console under Subscriptions. The two views are the same row.
Errors
| Status | Cause |
|---|---|
| 401 | Missing or invalid API key. |
| 403 | Key is missing the subscriptions:read scope. |
| 404 | No such object, or it belongs to the other mode. |
| 422 | Validation Error |
| 429 | Rate limited. Back off and retry. |
Other subscriptions operations
- List subscriptions GET /v1/subscriptions
- Cancel a subscription POST /v1/subscriptions/{subscription_id}/cancel
- Pause subscription POST /v1/subscriptions/{subscription_id}/pause
- Preview update subscription POST /v1/subscriptions/{subscription_id}/preview_update
- Reactivate subscription POST /v1/subscriptions/{subscription_id}/reactivate
- Reauthorize payment method POST /v1/subscriptions/{subscription_id}/reauthorize_payment_method
- Resume subscription POST /v1/subscriptions/{subscription_id}/resume
- Change a subscription's plan POST /v1/subscriptions/{subscription_id}/update
BillKit