billing

GET /v1/subscriptions/renewal-options

Every renewal card's crypto auto-renew state and one-period prepay quote, in one read.

All billing endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/subscriptions/renewal-options \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

For a page of the subscriptions the caller can manage billing for, what GET /v1/subscriptions/{subscriptionId}/crypto-auto-renew and GET /v1/subscriptions/{subscriptionId}/prepay-quote?periods=1 would each answer — so the billing page makes one request instead of two per subscription. The crypto part is read once for the whole page. A subscription that cannot be prepaid carries prepay_quote: null with the refusal code and sentence the single quote's 422 would have carried. Takes no money and creates no row. Cursor-paginated, RLS-scoped; requires billing.payment.manage (the key both single endpoints require: a quote names a price we will honour).

Parameters

NameTypeRequiredWhat it is
X-Zinn-Org (header)stringNoWhich organisation this call acts for. Send a client organisation's id and every org-scoped endpoint answers for that client alone; omit it and the answer covers everything…
cursor (query)stringNoOpaque cursor from a previous page's page.next_cursor.
limit (query)integerNoMaximum items to return (page size).
org_id (query)UuidNoRestrict to one organization in scope.

Response

NameTypeRequiredWhat it is
dataSubscriptionRenewalOptions[]Yes—
pagePageMetaYes—

Errors this endpoint can return

401 · 403 · 422 · 429