reseller
GET /v1/reseller/vendor-usage
What your clients drew from Zinn®'s vendor accounts this month.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation reseller.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/reseller/vendor-usage \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
org_id (query) | Uuid | Non | 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éponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
pool_enforced | boolean | Oui | 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> | Oui | — |
pool_micros | integer | Oui | — |
month_spent_micros | integer | Oui | Priced spend this calendar month. A **minimum** whenever `month_is_floor` is true. |
month_remaining_micros | integer | Oui | `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 | Oui | `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 | Oui | Billed calls this month excluded from the money total. |
should_warn | boolean | Oui | You have crossed `alert_at_bps` of your pool. |
ceiling_micros | integer | Oui | 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 | Oui | — |
org_count | integer | Oui | 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[] | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429