billing

PATCH `/v1/cdn/credit`

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

Wszystkie dokumentacje dla programistów →

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie billing.payment.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`spend_cap_minor`	`integer`	Nie	—
`auto_top_up`	`boolean`	Nie	—
`auto_top_up_amount_minor`	`integer`	Nie	—

Odpowiedź

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

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422 · 429

PATCH /v1/cdn/credit