reseller

GET `/v1/reseller/vendor-usage`

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

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea reseller.view; o cheie care nu o are va fi respinsă cu 403, nu 404.

Unde merge ID-ul organizației tale

Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.

ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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`.

Parametri

Nume	Tip	Obligatoriu	Ce este
`org_id (query)`	`Uuid`	Nu	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…

Răspuns

Nume	Tip	Obligatoriu	Ce este
`pool_enforced`	`boolean`	Da	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>`	Da	—
`pool_micros`	`integer`	Da	—
`month_spent_micros`	`integer`	Da	Priced spend this calendar month. A minimum whenever `month_is_floor` is true.
`month_remaining_micros`	`integer`	Da	`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`	Da	`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`	Da	Billed calls this month excluded from the money total.
`should_warn`	`boolean`	Da	You have crossed `alert_at_bps` of your pool.
`ceiling_micros`	`integer`	Da	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`	Da	—
`org_count`	`integer`	Da	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[]`	Da	—

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 429