billing

GET /v1/cdn/credit

The account's prepaid metered-CDN balance, spend cap and top-up settings.

Tutti gli endpoint billing

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione billing.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X GET https://api.zinndigital.com/v1/cdn/credit \
  -H "Authorization: Bearer zdk_live_…"

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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`.

Risposta

NomeTipoObbligatorioChe cos'è
currencystring
balance_minorinteger
spend_cap_minorintegerThe customer's own ceiling. Enforced, not advisory.
spent_period_minorinteger
min_spend_cap_minorintegerThe lowest cap the platform accepts.
auto_top_upbooleanOn by default. Refills the balance so serving continues **below** the cap; it never raises the cap.
auto_top_up_amount_minorinteger
statestring<active, paused_cap, paused_standing, paused_admin>
paused_reasonstringNo
worst_case_overshoot_minorintegerNoHow 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…

Errori che questo endpoint può restituire

401 · 403 · 404 · 429