billing
PATCH /v1/cdn/credit
Set the spend cap, or turn auto-top-up on or off.
認証
ベアラー トークンとして API キーを送信します。キーには billing.payment.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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_minor | integer | いいえ | — |
auto_top_up | boolean | いいえ | — |
auto_top_up_amount_minor | integer | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 hold… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429