reseller
POST /v1/reseller/services/{siteId}/suspend
Put a client's site on a non-payment hold.
Πισtoποίηση
Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Το κλειδί πρέπει να διαθέτει το δικαίωμα reseller.provision· ένα κλειδί που δεν το διαθέτει απορρίπτεται με 403, όχι 404.
Πού μπαίνει το αναγνωριστικό του οργανισμού σας
Αυτό το τελικό σημείο δέχεται την παράμετρο org_id ως παράμετρο ερωτήματος. Παραλείψτε την και η κλήση καλύπτει ολόκληρο το υποδέντρο μίσθωσής σας· στείλτε την για να περιορίσετε την κλήση σε έναν οργανισμό.
Το αναγνωριστικό του οργανισμού σας βρίσκεται στην οθόνη των κλειδιών API στον πίνακα ελέγχου σας, δίπλα στο ίδιο το κλειδί. Είναι το ίδιο αναγνωριστικό σε κάθε κλήση που πραγματοποιείτε.
Δοκιμάστε το
Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.
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.
Παράμετροι
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
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… |
Σώμα αίτησης
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
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. |
Απάντηση
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
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