billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea billing.payment.manage; o cheie care nu o are va fi respinsă cu 403, nu 404.
Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay-quote?periods=<periods> \
-H "Authorization: Bearer zdk_live_…"Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
subscriptionId (path) | Uuid | Da | The subscription being quoted for. |
periods (query) | integer | Da | How many whole billing periods to price. |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
subscription_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
periods | integer | Da | — |
interval | string<monthly, annual> | Da | — |
unit_amount_minor | integer | Da | The captured per-period price in minor units (§2.8) — never re-derived from the catalogue. |
total_amount_minor | integer | Da | Net of tax; tax is added on the order. |
currency | string | Da | — |
current_period_end | string | Da | — |
extends_to | string | Da | — |
max_periods | integer | Da | The most periods one payment may buy. |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 422 · 429