billing

GET /v1/subscriptions/{subscriptionId}/prepay-quote

Price paying for several billing periods at once.

Усі кінцеві точки billing

Уся документація для розробників

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл billing.payment.manage; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay-quote?periods=<periods> \
  -H "Authorization: Bearer zdk_live_…"

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого 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_idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
periodsintegerТак
intervalstring<monthly, annual>Так
unit_amount_minorintegerТакThe captured per-period price in minor units (§2.8) — never re-derived from the catalogue.
total_amount_minorintegerТакNet of tax; tax is added on the order.
currencystringТак
current_period_endstringТак
extends_tostringТак
max_periodsintegerТакThe most periods one payment may buy.

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422 · 429