billing

PATCH /v1/cdn/credit

Set the spend cap, or turn auto-top-up on or off.

所有 billing 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.payment.manage 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X PATCH https://api.zinndigital.com/v1/cdn/credit \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

The spend cap is the customer's and it is enforced, not advisory: reaching it pauses metered serving. It has a platform minimum, below which a cap would pause an account before it could do anything useful. Auto-top-up refills the **balance** so serving continues below the ceiling. It never raises the ceiling — a top-up that moved the cap would make the cap unreachable and turn a spending limit into a delay. Raising the cap above current spend resumes an account paused by that cap. It does **not** resume one paused by staff, or one paused because the account is not in good standing; those need the thing that actually caused them. Reading the balance is `billing.view`; changing a ceiling is a money change and requires `billing.payment.manage`.

请求正文

名称类型必填内容简介
spend_cap_minorinteger
auto_top_upboolean
auto_top_up_amount_minorinteger

响应

名称类型必填内容简介
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_reasonstring
worst_case_overshoot_minorintegerHow 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 · 422 · 429