reseller
GET /v1/reseller/clients/{orgId}/plan
Which plan this client is on, and what it costs you.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen reseller.view; një çelës pa të refuzohet me 403, jo 404.
Ku shkon id i organizatës suaj
Ky endpoint merr ID-në e organizatës suaj direkt në URL, si orgId. Zëvendësoni atë në shteg — nuk ka asnjë kokë (header) apo parametër query që bën punë në vend të kësaj.
ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
curl -X GET https://api.zinndigital.com/v1/reseller/clients/{orgId}/plan \
-H "Authorization: Bearer zdk_live_…"Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
The client's live plan, or nulls when they are not on one yet. `wholesale_amount_minor` is what Zinn® charges **you** per period for it — integer minor units, `null` and never `0` when the catalogue does not price it in the currency asked for. Requires `reseller.view`. An organization that is not one of your clients is a `404`, not a `403`, so this cannot be used to discover that an organization exists.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
orgId (path) | Uuid | Po | One of your client organizations. |
org_id (query) | Uuid | Jo | Which of YOUR organizations is asking. Required only when you belong to more than one. Not to be confused with the path parameter, which is your client. |
currency (query) | string | Jo | ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`. |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
client_org_id | Uuid | Po | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subscription_id | string | Jo | Pass this as `subscription_id` on `createSite`. Null when the client is on no plan — provisioning a site in that state is what leaves it unbilled. |
plan_code | string | Jo | — |
plan_name | string | Jo | — |
interval | string | Jo | — |
created | boolean | Po | True when this call granted the plan, false when the client was already on it. A retried provision needs the difference without inferring it from a timestamp. |
wholesale_amount_minor | integer | Jo | What Zinn® charges you per period. `null`, never `0`, when unpriced. |
wholesale_currency | string | Jo | — |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404 · 429