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

PATCH /v1/cdn/credit