reseller
POST /v1/reseller/services/{siteId}/suspend
Put a client's site on a non-payment hold.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie reseller.provision beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Waar je organisatie-id komt te staan
Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/reseller/services/{siteId}/suspend \
-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
Suspends a site you resell — the lever a billing panel pulls when your client has not paid you. The site stops serving and its content is retained; nothing is deleted. Requires `reseller.provision`. The hold is attributed to YOU, and that attribution is load-bearing: a site the malware ladder suspended cannot be released by `unsuspendResellerService`, and a site you suspended cannot be released from the abuse queue. Two different people hold two different keys to the same door, and neither may open the other's lock.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
siteId (path) | Uuid | Ja | Site ID (UUIDv7). |
org_id (query) | Uuid | Nee | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
reason | string | Nee | Your own note for the audit trail — typically the invoice number that went unpaid. Recorded against the suspension; never shown to the client. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
site_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_name | string | Ja | — |
primary_domain | string | Ja | — |
name | string | Nee | — |
status | SiteStatus | Ja | A site's lifecycle state (docs/04 §3). A newly created site is `pending` until the provisioning workflow picks it up; `deleted` is terminal. `restricted` and `quarantined` are t… |
product_line | object | Nee | — |
plan_code | object | Nee | — |
plan_name | object | Nee | — |
held_by_reseller | boolean | Nee | True when the current suspension was placed through this surface, which is the only case `unsuspendResellerService` will release. A site suspended by the abuse desk reports fals… |
pending_deletion_at | object | Nee | When a scheduled deletion falls due, or null. |
sell_amount_minor | object | Nee | What YOU charge for this plan, in minor units of `sell_currency` — your own price-list row if you have authored one, otherwise our list price with your default markup applied. N… |
sell_currency | object | Nee | — |
created_at | string | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 409 · 422 · 429