billing

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

Price paying for several billing periods at once.

Minden billing végpont

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.payment.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

NévTípusKötelezőMi ez
subscriptionId (path)UuidIgenThe subscription being quoted for.
periods (query)integerIgenHow many whole billing periods to price.

Válasz

NévTípusKötelezőMi ez
subscription_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
periodsintegerIgen
intervalstring<monthly, annual>Igen
unit_amount_minorintegerIgenThe captured per-period price in minor units (§2.8) — never re-derived from the catalogue.
total_amount_minorintegerIgenNet of tax; tax is added on the order.
currencystringIgen
current_period_endstringIgen
extends_tostringIgen
max_periodsintegerIgenThe most periods one payment may buy.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429