billing
GET /v1/cdn/credit
The account's prepaid metered-CDN balance, spend cap and top-up settings.
Authentication
Send an API key as a bearer token. The key must carry the billing.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/cdn/credit \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The metered Enterprise-edge tier is prepaid. This is the balance, the customer's own spend ceiling, what has been spent this period, and whether auto-top-up is on. `worst_case_overshoot_minor` is reported to the customer rather than hidden, and it is the honest part of this endpoint. A spend cap cannot be exact: between one usage sample and the cut-off, traffic keeps flowing, so the cap is overshot by `peak_bandwidth x poll_interval x rate`. That is bounded by a hard egress rate limit at the vendor, not by how often we poll — but it is not zero, and a product that promises an exact ceiling it cannot hold is worse than one that states the tolerance. Requires `billing.view`.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
currency | string | Yes | — |
balance_minor | integer | Yes | — |
spend_cap_minor | integer | Yes | The customer's own ceiling. Enforced, not advisory. |
spent_period_minor | integer | Yes | — |
min_spend_cap_minor | integer | Yes | The lowest cap the platform accepts. |
auto_top_up | boolean | Yes | On by default. Refills the balance so serving continues **below** the cap; it never raises the cap. |
auto_top_up_amount_minor | integer | Yes | — |
state | string<active, paused_cap, paused_standing, paused_admin> | Yes | — |
paused_reason | string | No | — |
worst_case_overshoot_minor | integer | No | How far past the cap spending can run before the next usage sample stops it. Reported rather than hidden: the cap cannot be exact, and a product promising a ceiling it cannot ho… |
Errors this endpoint can return
401 · 403 · 404 · 429