billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran billing.payment.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay-quote?periods=<periods> \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
subscriptionId (path) | Uuid | Ya | The subscription being quoted for. |
periods (query) | integer | Ya | How many whole billing periods to price. |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
subscription_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
periods | integer | Ya | — |
interval | string<monthly, annual> | Ya | — |
unit_amount_minor | integer | Ya | The captured per-period price in minor units (§2.8) — never re-derived from the catalogue. |
total_amount_minor | integer | Ya | Net of tax; tax is added on the order. |
currency | string | Ya | — |
current_period_end | string | Ya | — |
extends_to | string | Ya | — |
max_periods | integer | Ya | The most periods one payment may buy. |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422 · 429