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 hold… |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422 · 429