billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.payment.manage; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay-quote?periods=<periods> \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
subscriptionId (path) | Uuid | Sim | The subscription being quoted for. |
periods (query) | integer | Sim | How many whole billing periods to price. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
subscription_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
periods | integer | Sim | — |
interval | string<monthly, annual> | Sim | — |
unit_amount_minor | integer | Sim | The captured per-period price in minor units (§2.8) — never re-derived from the catalogue. |
total_amount_minor | integer | Sim | Net of tax; tax is added on the order. |
currency | string | Sim | — |
current_period_end | string | Sim | — |
extends_to | string | Sim | — |
max_periods | integer | Sim | The most periods one payment may buy. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429