reseller
GET /v1/reseller/clients/{orgId}/plan
Which plan this client is on, and what it costs you.
Санҷиши ҳаққоният
Kaliti API-ро ҳамчун рамзи доранда (bearer token) фиристед. Калит бояд дорои иҷозати reseller.view бошад; калиди бидуни он бо хатои 403 рад карда мешавад, на 404.
Ҷое, ки рақами мушаххаси ташкилоти шумо ҷойгир аст
Ин нуқтаи ниҳоӣ ID-и ташкилоти шуморо дар худи URL ҳамчун orgId қабул мекунад. Онро ба роҳ ворид кунед — ягон сарлавҳа ё параметри дархосте нест, ки ҷои онро гирад.
Rakami муайянкунандаи ташкилоти шумо дар экрани калидҳои API дар панели идоракунии шумо, дар паҳлӯи худи калид ҷойгир аст. Ин як раками муайянкунанда дар ҳар یک дархосте, ки шумо иҷро мекунед, якхела аст.
Санҷидан
Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.
curl -X GET https://api.zinndigital.com/v1/reseller/clients/{orgId}/plan \
-H "Authorization: Bearer zdk_live_…"Воarid шудаед? Консоли API дар панели идоракунии шумо рақами мушаххаси ташкилоти воқеӣ ва калиди худро пур мекунад ва дархостро бар зидди API-и фаъол иҷро мекунад, то шумо посухи воқеиро бубинед. Ин нуқтаи ниҳоиро дар консоли API кушоед
Тафсилот
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.
Параметрҳо
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
orgId (path) | Uuid | Бале | One of your client organizations. |
org_id (query) | Uuid | Не | 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 | Не | ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`. |
Ҷавоб
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
client_org_id | Uuid | Бале | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subscription_id | string | Не | 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 | Не | — |
plan_name | string | Не | — |
interval | string | Не | — |
created | boolean | Бале | 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 | Не | What Zinn® charges you per period. `null`, never `0`, when unpriced. |
wholesale_currency | string | Не | — |
Хатоҳое, ки ин нуқтаи ниҳоӣ метавонад баргардонад
401 · 403 · 404 · 429