reseller

GET `/v1/reseller/vendor-usage`

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

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya reseller.view; ufunguo usio nayo unakataliwa kwa 403, si 404.

Mahali ambapo kitambulisho cha shirika lako huwekwa

Kigezo hiki kinachukua org_id kama kigezo cha utafutaji. Iache wazi na simu itashughulikia tawi lako lote la wapangaji; itume ili kupunguza simu iwe ya shirika moja tu.

Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`org_id (query)`	`Uuid`	Hapana	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…

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`pool_enforced`	`boolean`	Ndiyo	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>`	Ndiyo	—
`pool_micros`	`integer`	Ndiyo	—
`month_spent_micros`	`integer`	Ndiyo	Priced spend this calendar month. A minimum whenever `month_is_floor` is true.
`month_remaining_micros`	`integer`	Ndiyo	`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`	Ndiyo	`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`	Ndiyo	Billed calls this month excluded from the money total.
`should_warn`	`boolean`	Ndiyo	You have crossed `alert_at_bps` of your pool.
`ceiling_micros`	`integer`	Ndiyo	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`	Ndiyo	—
`org_count`	`integer`	Ndiyo	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[]`	Ndiyo	—

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 429