reseller
GET /v1/reseller/clients/{orgId}/plan
Which plan this client is on, and what it costs you.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу reseller.view; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка узима ID ваше организације у самом URL-у, као orgId. Замените га у путањи — не постоји заглавље или параметар упита који могу послужити уместо тога.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/reseller/clients/{orgId}/plan \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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