billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.payment.manage 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/prepay-quote?periods=<periods> \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 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