billing

POST `/v1/subscriptions/{subscriptionId}/prepay`

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

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.payment.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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`.

Parameters

Naam	Type	Verplicht	Wat dit is
`subscriptionId (path)`	`Uuid`	Ja	The subscription to pay ahead on.

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`periods`	`integer`	Ja	How many whole billing periods to pay for now.

Reactie

Naam	Type	Verplicht	Wat dit is
`order_id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`order_number`	`string`	Ja	—
`periods`	`integer`	Ja	—
`total_amount_minor`	`integer`	Ja	Including tax.
`currency`	`string`	Ja	—
`status`	`string`	Ja	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422 · 429

POST /v1/subscriptions/{subscriptionId}/prepay