billing

POST /v1/subscriptions/{subscriptionId}/prepay

Create the order to pay for several billing periods at once.

എല്ലാ billing എൻഡ്‌പോയിന്റുകളും

പ്രമാണീകരണം

ബെയറർ ടോക്കണായി ഒരു API കീ അയയ്ക്കുക. കീക്ക് billing.payment.manage അനുമതി ഉണ്ടായിരിക്കണം; അനുമതിയില്ലാത്ത കീ 404 അല്ല, 403 നൽകി നിരസിക്കപ്പെടും.

ഈ എൻഡ്പോയിന്റ് ഓർഗനൈസേഷൻ ഐഡി സ്വീകരിക്കുന്നില്ല. നിങ്ങളുടെ കീ അത് ഉൾപ്പെടുന്ന ഓർഗനൈസേഷനെ ഇതിനകം തിരിച്ചറിയുന്നുണ്ട്, ഒപ്പം പ്രതികരണം അതിലേക്ക് പരിമിതപ്പെടുത്തിയിരിക്കുന്നു.

ശ്രമിച്ച് നോക്കൂ

കോണമ്ബ്രക്കറ്റുകളിലുള്ള ഏതും നിങ്ങളുടെ സ്വന്തം മൂല്യങ്ങൾ ഉപയോഗിച്ച് മാറ്റിസ്ഥാപിക്കുക, കീ പ്ലേസ്‌ഹോൾഡർ നിങ്ങളുടെ ഡാഷ്‌ബോർഡിലെ ഒരു കീ ഉപയോഗിച്ചും മാറ്റിസ്ഥാപിക്കുക.

curl -X POST https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "periods": <integer> }'

സൈൻ ഇൻ ചെയ്തിട്ടുണ്ടോ? നിങ്ങളുടെ ഡാഷ്‌ബോർഡിലെ API കൺസോൾ നിങ്ങളുടെ യഥാർത്ഥ ഓർഗനൈസേഷൻ ഐഡിയും നിങ്ങളുടെ സ്വന്തം കീയും പൂരിപ്പിക്കുകയും, യഥാർത്ഥ പ്രതികരണം (response) നിങ്ങൾക്ക് കാണുന്നതിനായി ലൈവ് API-ലേക്ക് അഭ്യർത്ഥന (request) പ്രവർത്തിപ്പിക്കുകയും ചെയ്യുന്നു. ഈ എൻഡ്പോയിന്റ് API കൺസോളിൽ തുറക്കുക

വിശദാംശങ്ങൾ

Mints an **unpaid** order for N whole billing periods. ⛔⛔ **No money is taken here.** The client then settles that order through `POST /v1/orders/{orderId}/pay`, which already knows how to pay from account balance, from a gateway, or from both. That separation is the point rather than an implementation detail: it is what lets a customer with **no chargeable mandate** use this at all — somebody paying in crypto, or in a market whose regulator forbids an off-session charge. They top up once and pay six months from their balance, with no card anywhere in the flow. Replaying the same request returns the **same** order rather than a second one, so a double-clicked button cannot bill twice. Asking for a *different* number of periods supersedes the earlier unpaid prepay order and mints a fresh one — a customer changing their mind is not a collision. An unpaid order against this subscription that is **not** a prepayment (a plan change, say) is refused with `ORDER_IN_FLIGHT` instead, and is never cancelled on the customer's behalf. Requires `billing.payment.manage`. `422` carries a `code` in its details: `TOO_FEW` / `TOO_MANY` (outside the allowed range), `NOT_PREPAYABLE` (ended, comped or free), `RAIL_NOT_SUPPORTED` (billed by PayPal on its own schedule), or `ORDER_IN_FLIGHT`.

പരാമീറ്ററുകൾ

പേര്തരംആവശ്യമാണ്എന്താണിത്
subscriptionId (path)UuidഅതെThe subscription to pay ahead on.

അഭ്യർത്ഥന ബോഡി

പേര്തരംആവശ്യമാണ്എന്താണിത്
periodsintegerഅതെHow many whole billing periods to pay for now.

പ്രതികരണം

പേര്തരംആവശ്യമാണ്എന്താണിത്
order_idUuidഅതെUUIDv7 identifier — sortable by creation time (docs/02 §8).
order_numberstringഅതെ
periodsintegerഅതെ
total_amount_minorintegerഅതെIncluding tax.
currencystringഅതെ
statusstringഅതെ

ഈ എൻഡ്‌പോയിന്റ് നൽകാൻ കഴിയുന്ന പിഴവുകൾ

401 · 403 · 404 · 422 · 429