billing
GET /v1/entitlements
What this organization's plan grants, and how much of it is used.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/entitlements \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
org_id (query) | Uuid | 否 | The organization to report on; defaults to the caller's own. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
entitling_org_id | Uuid | 是 | 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> | 是 | 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 | 是 | — |
has_plan | boolean | 是 | — |
allowances | EntitlementAllowance[] | 是 | — |
features | EntitlementFeature[] | 是 | — |
此端点可能返回的错误
401 · 403 · 429