reseller
POST /v1/reseller/services/{siteId}/suspend
Put a client's site on a non-payment hold.
Authentication
Send an API key as a bearer token. The key must carry the reseller.provision permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/reseller/services/{siteId}/suspend \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the 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
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
org_id (query) | Uuid | No | 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… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
reason | string | No | Your own note for the audit trail — typically the invoice number that went unpaid. Recorded against the suspension; never shown to the client. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_name | string | Yes | — |
primary_domain | string | Yes | — |
name | string | No | — |
status | SiteStatus | Yes | 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 the… |
product_line | object | No | — |
plan_code | object | No | — |
plan_name | object | No | — |
held_by_reseller | boolean | No | 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 false… |
pending_deletion_at | object | No | When a scheduled deletion falls due, or null. |
sell_amount_minor | object | No | 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.… |
sell_currency | object | No | — |
created_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 409 · 422 · 429