billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
Autentifikatsiya
API kalitini bearer token sifatida yuboring. Kalit billing.payment.manage ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.
Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
curl -X GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay-quote?periods=<periods> \
-H "Authorization: Bearer zdk_live_…"Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
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.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
subscriptionId (path) | Uuid | Ha | The subscription being quoted for. |
periods (query) | integer | Ha | How many whole billing periods to price. |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
subscription_id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
periods | integer | Ha | — |
interval | string<monthly, annual> | Ha | — |
unit_amount_minor | integer | Ha | The captured per-period price in minor units (§2.8) — never re-derived from the catalogue. |
total_amount_minor | integer | Ha | Net of tax; tax is added on the order. |
currency | string | Ha | — |
current_period_end | string | Ha | — |
extends_to | string | Ha | — |
max_periods | integer | Ha | The most periods one payment may buy. |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 422 · 429