reseller

GET `/v1/reseller/vendor-usage`

What your clients drew from Zinn®'s vendor accounts this month.

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie reseller.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Waar je organisatie-id komt te staan

Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X GET https://api.zinndigital.com/v1/reseller/vendor-usage \
  -H "Authorization: Bearer zdk_live_…"

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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

Naam	Type	Verplicht	Wat dit is
`org_id (query)`	`Uuid`	Nee	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…

Reactie

Naam	Type	Verplicht	Wat dit is
`pool_enforced`	`boolean`	Ja	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>`	Ja	—
`pool_micros`	`integer`	Ja	—
`month_spent_micros`	`integer`	Ja	Priced spend this calendar month. A minimum whenever `month_is_floor` is true.
`month_remaining_micros`	`integer`	Ja	`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`	Ja	`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`	Ja	Billed calls this month excluded from the money total.
`should_warn`	`boolean`	Ja	You have crossed `alert_at_bps` of your pool.
`ceiling_micros`	`integer`	Ja	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`	Ja	—
`org_count`	`integer`	Ja	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[]`	Ja	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 429