billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу billing.payment.manage; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay-quote?periods=<periods> \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
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.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
subscriptionId (path) | Uuid | Да | The subscription being quoted for. |
periods (query) | integer | Да | How many whole billing periods to price. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
subscription_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
periods | integer | Да | — |
interval | string<monthly, annual> | Да | — |
unit_amount_minor | integer | Да | The captured per-period price in minor units (§2.8) — never re-derived from the catalogue. |
total_amount_minor | integer | Да | Net of tax; tax is added on the order. |
currency | string | Да | — |
current_period_end | string | Да | — |
extends_to | string | Да | — |
max_periods | integer | Да | The most periods one payment may buy. |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422 · 429