billing
PATCH /v1/cdn/credit
Set the spend cap, or turn auto-top-up on or off.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה billing.payment.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X PATCH https://api.zinndigital.com/v1/cdn/credit \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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 ho… |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422 · 429