billing
GET /v1/cdn/credit
The account's prepaid metered-CDN balance, spend cap and top-up settings.
認証
ベアラー トークンとして API キーを送信します。キーには billing.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/cdn/credit \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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