billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.payment.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay-quote?periods=<periods> \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
subscriptionId (path) | Uuid | Ano | The subscription being quoted for. |
periods (query) | integer | Ano | How many whole billing periods to price. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
subscription_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
periods | integer | Ano | — |
interval | string<monthly, annual> | Ano | — |
unit_amount_minor | integer | Ano | The captured per-period price in minor units (§2.8) — never re-derived from the catalogue. |
total_amount_minor | integer | Ano | Net of tax; tax is added on the order. |
currency | string | Ano | — |
current_period_end | string | Ano | — |
extends_to | string | Ano | — |
max_periods | integer | Ano | The most periods one payment may buy. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422 · 429