reseller
GET /v1/reseller/vendor-usage
What your clients drew from Zinn®'s vendor accounts this month.
Authentication
Send an API key as a bearer token. The key must carry the reseller.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/reseller/vendor-usage \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | 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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
pool_enforced | boolean | Yes | 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> | Yes | — |
pool_micros | integer | Yes | — |
month_spent_micros | integer | Yes | Priced spend this calendar month. A minimum whenever month_is_floor is true. |
month_remaining_micros | integer | Yes | 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 | Yes | 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 | Yes | Billed calls this month excluded from the money total. |
should_warn | boolean | Yes | You have crossed alert_at_bps of your pool. |
ceiling_micros | integer | Yes | 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 | Yes | — |
org_count | integer | Yes | 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[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429