billing

PATCH `/v1/cdn/credit`

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

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.payment.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Tělo požadavku

Název	Typ	Požadováno	Co to je
`spend_cap_minor`	`integer`	Ne	—
`auto_top_up`	`boolean`	Ne	—
`auto_top_up_amount_minor`	`integer`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`currency`	`string`	Ano	—
`balance_minor`	`integer`	Ano	—
`spend_cap_minor`	`integer`	Ano	The customer's own ceiling. Enforced, not advisory.
`spent_period_minor`	`integer`	Ano	—
`min_spend_cap_minor`	`integer`	Ano	The lowest cap the platform accepts.
`auto_top_up`	`boolean`	Ano	On by default. Refills the balance so serving continues below the cap; it never raises the cap.
`auto_top_up_amount_minor`	`integer`	Ano	—
`state`	`string<active, paused_cap, paused_standing, paused_admin>`	Ano	—
`paused_reason`	`string`	Ne	—
`worst_case_overshoot_minor`	`integer`	Ne	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…

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429

PATCH /v1/cdn/credit