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