billing
GET /v1/entitlements
What this organization's plan grants, and how much of it is used.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/entitlements \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
The customer-facing half of entitlement enforcement (#2726). Returns every counted allowance the engine refuses on — with used, limit and remaining — and every boolean feature it gates on, marked included or not. A cap the engine refuses on and the customer cannot see is a cap nobody can plan around: the first they learn of it is the moment it stops them. So the numbers here are the same numbers the refusal quotes. limit distinguishes three states (docs/144 §1) and they are not interchangeable: -1 means the plan sold "unlimited" and says so; a non-negative integer is a real cap; null means the plan states no cap at all, which is neither a promise nor a limit and is the normal case — only 8 of 134 live plans state team_seats. enforced is the single field a client should branch on to decide whether to draw a usage bar. Resolution walks the organization tree: a reseller's client org holds no subscription of its own, so the answer comes from the nearest ancestor that grants one, and entitling_org_id names it. Requires billing.view.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id (query) | Uuid | Ne | The organization to report on; defaults to the caller's own. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
entitling_org_id | Uuid | Ano | The organization whose plan grants these — the caller's own org or an ancestor. Null when nothing in the chain grants anything. |
source | string<staff, subscription, none> | Ano | Where the grant came from. The customer's next move differs: a staff grant is not upgradable, a subscription one is, and none means there is nothing to upgrade from — buy… |
plan_name | string | Ano | — |
has_plan | boolean | Ano | — |
allowances | EntitlementAllowance[] | Ano | — |
features | EntitlementFeature[] | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 429