A valid request URL is required to generate request examples{
"environment": "live",
"subscriptions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "incomplete",
"current_period_start": "2023-11-07T05:31:56Z",
"current_period_end": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"canceled_at": "2023-11-07T05:31:56Z",
"trial_ends_at": "2023-11-07T05:31:56Z",
"provider": "stripe",
"provider_account_id": "<string>",
"provider_subscription_id": "<string>",
"provider_synced_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"price": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "recurring",
"currency": "<string>",
"amount_minor": 123,
"tax_behavior": "inclusive",
"archived": true
}
}
],
"capabilities": {
"scheduled_plan_change": true,
"proration": true,
"cancel_at_period_end": true,
"hosted_portal": true,
"tax_calculation": true,
"resume_subscription": true,
"list_invoices": true,
"list_catalogue": true,
"publish_catalogue": true,
"manage_coupons": true,
"pause_subscription": true,
"discount_subscription": true,
"refund_payment": true
},
"mirror_refreshed": true,
"mirror_stale_reason": "provider_reread_failed",
"unmapped_provider_price_id": "<string>"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}List subscriptions
Requires billing:read. Every subscription in one environment, newest first, every status included — a cancelled one is what somebody is looking for when they ask why a customer lost access.
The lines are not here; read one subscription for those.
A valid request URL is required to generate request examples{
"environment": "live",
"subscriptions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "incomplete",
"current_period_start": "2023-11-07T05:31:56Z",
"current_period_end": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"canceled_at": "2023-11-07T05:31:56Z",
"trial_ends_at": "2023-11-07T05:31:56Z",
"provider": "stripe",
"provider_account_id": "<string>",
"provider_subscription_id": "<string>",
"provider_synced_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"price": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "recurring",
"currency": "<string>",
"amount_minor": 123,
"tax_behavior": "inclusive",
"archived": true
}
}
],
"capabilities": {
"scheduled_plan_change": true,
"proration": true,
"cancel_at_period_end": true,
"hosted_portal": true,
"tax_calculation": true,
"resume_subscription": true,
"list_invoices": true,
"list_catalogue": true,
"publish_catalogue": true,
"manage_coupons": true,
"pause_subscription": true,
"discount_subscription": true,
"refund_payment": true
},
"mirror_refreshed": true,
"mirror_stale_reason": "provider_reread_failed",
"unmapped_provider_price_id": "<string>"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Query Parameters
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test Page size. Values outside 1–200 fall back to 50.
1 <= x <= 200x >= 0