reseller
POST /v1/reseller/services/{siteId}/suspend
Put a client's site on a non-payment hold.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.provision; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/reseller/services/{siteId}/suspend \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
org_id (query) | Uuid | Não | 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… |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
reason | string | Não | Your own note for the audit trail — typically the invoice number that went unpaid. Recorded against the suspension; never shown to the client. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
site_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_name | string | Sim | — |
primary_domain | string | Sim | — |
name | string | Não | — |
status | SiteStatus | Sim | 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 | Não | — |
plan_code | object | Não | — |
plan_name | object | Não | — |
held_by_reseller | boolean | Não | 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 | Não | When a scheduled deletion falls due, or null. |
sell_amount_minor | object | Não | 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 | Não | — |
created_at | string | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 409 · 422 · 429