reseller

GET `/v1/reseller/vendor-usage`

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

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie reseller.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

Nazwa	Typ	Wymagane	Co to jest
`org_id (query)`	`Uuid`	Nie	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…

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`pool_enforced`	`boolean`	Tak	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>`	Tak	—
`pool_micros`	`integer`	Tak	—
`month_spent_micros`	`integer`	Tak	Priced spend this calendar month. A minimum whenever `month_is_floor` is true.
`month_remaining_micros`	`integer`	Tak	`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`	Tak	`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`	Tak	Billed calls this month excluded from the money total.
`should_warn`	`boolean`	Tak	You have crossed `alert_at_bps` of your pool.
`ceiling_micros`	`integer`	Tak	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`	Tak	—
`org_count`	`integer`	Tak	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[]`	Tak	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429