Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.payment.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X PATCH https://api.zinndigital.com/v1/cdn/credit \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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`.
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
spend_cap_minor | integer | Nee | — |
auto_top_up | boolean | Nee | — |
auto_top_up_amount_minor | integer | Nee | — |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
currency | string | Ja | — |
balance_minor | integer | Ja | — |
spend_cap_minor | integer | Ja | The customer's own ceiling. Enforced, not advisory. |
spent_period_minor | integer | Ja | — |
min_spend_cap_minor | integer | Ja | The lowest cap the platform accepts. |
auto_top_up | boolean | Ja | On by default. Refills the balance so serving continues **below** the cap; it never raises the cap. |
auto_top_up_amount_minor | integer | Ja | — |
state | string<active, paused_cap, paused_standing, paused_admin> | Ja | — |
paused_reason | string | Nee | — |
worst_case_overshoot_minor | integer | Nee | 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… |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422 · 429