billing

GET /v1/cdn/credit

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

همه نقاط پایانی billing

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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`.

پاسخ

نامنوعالزامیچیست
currencystringبله
balance_minorintegerبله
spend_cap_minorintegerبلهThe customer's own ceiling. Enforced, not advisory.
spent_period_minorintegerبله
min_spend_cap_minorintegerبلهThe lowest cap the platform accepts.
auto_top_upbooleanبلهOn 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_reasonstringخیر
worst_case_overshoot_minorintegerخیر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