billing
GET /v1/cdn/credit
The account's prepaid metered-CDN balance, spend cap and top-up settings.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение billing.view; ключ без него отклоняется с кодом 403, а не 404.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/cdn/credit \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
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`.
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
currency | string | Да | — |
balance_minor | integer | Да | — |
spend_cap_minor | integer | Да | The customer's own ceiling. Enforced, not advisory. |
spent_period_minor | integer | Да | — |
min_spend_cap_minor | integer | Да | The lowest cap the platform accepts. |
auto_top_up | boolean | Да | On by default. Refills the balance so serving continues **below** the cap; it never raises the cap. |
auto_top_up_amount_minor | integer | Да | — |
state | string<active, paused_cap, paused_standing, paused_admin> | Да | — |
paused_reason | string | Нет | — |
worst_case_overshoot_minor | integer | Нет | 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… |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 429