billing

PATCH `/v1/cdn/credit`

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

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.payment.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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`.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`spend_cap_minor`	`integer`	Não	—
`auto_top_up`	`boolean`	Não	—
`auto_top_up_amount_minor`	`integer`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`currency`	`string`	Sim	—
`balance_minor`	`integer`	Sim	—
`spend_cap_minor`	`integer`	Sim	The customer's own ceiling. Enforced, not advisory.
`spent_period_minor`	`integer`	Sim	—
`min_spend_cap_minor`	`integer`	Sim	The lowest cap the platform accepts.
`auto_top_up`	`boolean`	Sim	On by default. Refills the balance so serving continues below the cap; it never raises the cap.
`auto_top_up_amount_minor`	`integer`	Sim	—
`state`	`string<active, paused_cap, paused_standing, paused_admin>`	Sim	—
`paused_reason`	`string`	Não	—
`worst_case_overshoot_minor`	`integer`	Não	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…

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429

PATCH /v1/cdn/credit