billing

PATCH `/v1/cdn/credit`

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

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.payment.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`spend_cap_minor`	`integer`	Non	—
`auto_top_up`	`boolean`	Non	—
`auto_top_up_amount_minor`	`integer`	Non	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`currency`	`string`	Oui	—
`balance_minor`	`integer`	Oui	—
`spend_cap_minor`	`integer`	Oui	The customer's own ceiling. Enforced, not advisory.
`spent_period_minor`	`integer`	Oui	—
`min_spend_cap_minor`	`integer`	Oui	The lowest cap the platform accepts.
`auto_top_up`	`boolean`	Oui	On by default. Refills the balance so serving continues below the cap; it never raises the cap.
`auto_top_up_amount_minor`	`integer`	Oui	—
`state`	`string<active, paused_cap, paused_standing, paused_admin>`	Oui	—
`paused_reason`	`string`	Non	—
`worst_case_overshoot_minor`	`integer`	Non	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…

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422 · 429

PATCH /v1/cdn/credit