billing

PATCH `/v1/cdn/credit`

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

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.payment.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`spend_cap_minor`	`integer`	Nem	—
`auto_top_up`	`boolean`	Nem	—
`auto_top_up_amount_minor`	`integer`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`currency`	`string`	Igen	—
`balance_minor`	`integer`	Igen	—
`spend_cap_minor`	`integer`	Igen	The customer's own ceiling. Enforced, not advisory.
`spent_period_minor`	`integer`	Igen	—
`min_spend_cap_minor`	`integer`	Igen	The lowest cap the platform accepts.
`auto_top_up`	`boolean`	Igen	On by default. Refills the balance so serving continues below the cap; it never raises the cap.
`auto_top_up_amount_minor`	`integer`	Igen	—
`state`	`string<active, paused_cap, paused_standing, paused_admin>`	Igen	—
`paused_reason`	`string`	Nem	—
`worst_case_overshoot_minor`	`integer`	Nem	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…

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429

PATCH /v1/cdn/credit