reseller

GET `/v1/reseller/vendor-usage`

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

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar reseller.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`org_id (query)`	`Uuid`	Hayır	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…

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`pool_enforced`	`boolean`	Evet	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>`	Evet	—
`pool_micros`	`integer`	Evet	—
`month_spent_micros`	`integer`	Evet	Priced spend this calendar month. A minimum whenever `month_is_floor` is true.
`month_remaining_micros`	`integer`	Evet	`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`	Evet	`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`	Evet	Billed calls this month excluded from the money total.
`should_warn`	`boolean`	Evet	You have crossed `alert_at_bps` of your pool.
`ceiling_micros`	`integer`	Evet	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`	Evet	—
`org_count`	`integer`	Evet	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[]`	Evet	—

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 429