billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
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.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
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/{subscriptionId}/prepay-quote?periods=<periods> \
-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
What N more whole billing periods would cost, and the date the subscription would then run to. Takes no money and creates no row, so a slider can be moved without minting an order per keystroke. The price is the captured per-period price multiplied — never re-derived from the catalogue. A live subscriber keeps the price they were sold (docs/05 §1), so a customer on a legacy or discounted rate is not silently re-priced for choosing to pay early. ⛔ It makes no claim about the customer's balance. Funds are read once, at charge time. A quote that asserted "you have enough" would be quoting a number that can change before the customer presses the button — including by a downgrade crediting their account. Requires billing.payment.manage. 404 for a subscription in another tenant as well as for one that does not exist. 422 when the subscription cannot be prepaid — it has ended, it is comped, it is free, or it is on the PayPal rail — with a code in the error details naming which.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
subscriptionId (path) | Uuid | Yes | The subscription being quoted for. |
periods (query) | integer | Yes | How many whole billing periods to price. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
subscription_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
periods | integer | Yes | — |
interval | string<monthly, annual> | Yes | — |
unit_amount_minor | integer | Yes | The captured per-period price in minor units (§2.8) — never re-derived from the catalogue. |
total_amount_minor | integer | Yes | Net of tax; tax is added on the order. |
currency | string | Yes | — |
current_period_end | string | Yes | — |
extends_to | string | Yes | — |
max_periods | integer | Yes | The most periods one payment may buy. |
debt_amount_minor | integer | No | s1014 R40 GAP-9 (docs/747 §2c): a recorded debt — service already provided, brought back by staff while still owed — that this order pays FIRST, net minor units. Included in… |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429