reseller
POST /v1/reseller/services/{siteId}/suspend
Put a client's site on a non-payment hold.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה reseller.provision; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X POST https://api.zinndigital.com/v1/reseller/services/{siteId}/suspend \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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