reseller
POST /v1/reseller/services/{siteId}/suspend
Put a client's site on a non-payment hold.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 reseller.provision 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/reseller/services/{siteId}/suspend \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
siteId (path) | Uuid | 是 | Site ID (UUIDv7). |
org_id (query) | Uuid | 否 | 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… |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
reason | string | 否 | Your own note for the audit trail — typically the invoice number that went unpaid. Recorded against the suspension; never shown to the client. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
site_id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_name | string | 是 | — |
primary_domain | string | 是 | — |
name | string | 否 | — |
status | SiteStatus | 是 | 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 | 否 | — |
plan_code | object | 否 | — |
plan_name | object | 否 | — |
held_by_reseller | boolean | 否 | 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 | 否 | When a scheduled deletion falls due, or null. |
sell_amount_minor | object | 否 | 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 | 否 | — |
created_at | string | 是 | — |
此端点可能返回的错误
401 · 403 · 404 · 409 · 422 · 429