reseller
GET /v1/reseller/vendor-usage
What your clients drew from Zinn®'s vendor accounts this month.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение reseller.view; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/reseller/vendor-usage \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Spend for your whole client base this calendar month, against your pool, broken down by vendor. Always read `month_is_floor` and `ceiling_is_floor` before showing a total: some vendors bill prepaid units whose per-unit cost is not priced here, so when a flag is `true` the money figure is a **minimum** and `month_unpriced_calls` counts what it excludes. `ceiling_micros` is the most your client base could draw in a month if every client used every allowance their plan includes — it does not depend on how busy this month happened to be. Available even when your pool is spent. Requires `reseller.view`.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
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… |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
pool_enforced | boolean | Да | Read this first. `false` means no pool has been set, so nothing is bounded — it does not mean you have a large allowance remaining. |
seo_data_mode | string<own_keys, platform_pool> | Да | — |
pool_micros | integer | Да | — |
month_spent_micros | integer | Да | Priced spend this calendar month. A **minimum** whenever `month_is_floor` is true. |
month_remaining_micros | integer | Да | `null` when no pool is set, or when the month's spend is a floor — an unknown cannot be subtracted from a budget to give a remainder. |
month_is_floor | boolean | Да | `true` means `month_spent_micros` understates the truth because a vendor we cannot price per call was used. Show it beside the number. |
month_unpriced_calls | integer | Да | Billed calls this month excluded from the money total. |
should_warn | boolean | Да | You have crossed `alert_at_bps` of your pool. |
ceiling_micros | integer | Да | The most your client base could draw in a month if every client used every allowance their plan includes. Independent of how busy this month was. |
ceiling_is_floor | boolean | Да | — |
org_count | integer | Да | Organizations counted — you plus your clients. A client of yours who is themselves a reseller has their own pool and is not counted beyond themselves. |
services | ResellerVendorServiceDraw[] | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 429