billing
GET /v1/subscriptions/{subscriptionId}/prepay-quote
Price paying for several billing periods at once.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 billing.payment.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 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