billing
GET /v1/cdn/credit
The account's prepaid metered-CDN balance, spend cap and top-up settings.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung billing.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X GET https://api.zinndigital.com/v1/cdn/credit \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
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`.
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
currency | string | Ja | — |
balance_minor | integer | Ja | — |
spend_cap_minor | integer | Ja | The customer's own ceiling. Enforced, not advisory. |
spent_period_minor | integer | Ja | — |
min_spend_cap_minor | integer | Ja | The lowest cap the platform accepts. |
auto_top_up | boolean | Ja | On by default. Refills the balance so serving continues **below** the cap; it never raises the cap. |
auto_top_up_amount_minor | integer | Ja | — |
state | string<active, paused_cap, paused_standing, paused_admin> | Ja | — |
paused_reason | string | Nein | — |
worst_case_overshoot_minor | integer | Nein | 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… |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 429