billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.payment.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay-quote?periods=<periods> \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
subscriptionId (path) | Uuid | Ja | The subscription being quoted for. |
periods (query) | integer | Ja | How many whole billing periods to price. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
subscription_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
periods | integer | Ja | — |
interval | string<monthly, annual> | Ja | — |
unit_amount_minor | integer | Ja | The captured per-period price in minor units (§2.8) — never re-derived from the catalogue. |
total_amount_minor | integer | Ja | Net of tax; tax is added on the order. |
currency | string | Ja | — |
current_period_end | string | Ja | — |
extends_to | string | Ja | — |
max_periods | integer | Ja | The most periods one payment may buy. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422 · 429