billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
تصدیقهویت
یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د billing.payment.manage اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.
دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
curl -X GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay-quote?periods=<periods> \
-H "Authorization: Bearer zdk_live_…"ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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