reseller
GET /v1/reseller/vendor-usage
What your clients drew from Zinn®'s vendor accounts this month.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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[] | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429