reseller
GET /v1/reseller/clients/{orgId}/plan
Which plan this client is on, and what it costs you.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 reseller.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点直接在 URL 中接受您的组织 ID，即 orgId。请将其替换到路径中——没有其他标头或查询参数可以替代此操作。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/reseller/clients/{orgId}/plan \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
The client's live plan, or nulls when they are not on one yet. `wholesale_amount_minor` is what Zinn® charges **you** per period for it — integer minor units, `null` and never `0` when the catalogue does not price it in the currency asked for. Requires `reseller.view`. An organization that is not one of your clients is a `404`, not a `403`, so this cannot be used to discover that an organization exists.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
orgId (path) | Uuid | 是 | One of your client organizations. |
org_id (query) | Uuid | 否 | Which of YOUR organizations is asking. Required only when you belong to more than one. Not to be confused with the path parameter, which is your client. |
currency (query) | string | 否 | ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
client_org_id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subscription_id | string | 否 | Pass this as `subscription_id` on `createSite`. Null when the client is on no plan — provisioning a site in that state is what leaves it unbilled. |
plan_code | string | 否 | — |
plan_name | string | 否 | — |
interval | string | 否 | — |
created | boolean | 是 | True when this call granted the plan, false when the client was already on it. A retried provision needs the difference without inferring it from a timestamp. |
wholesale_amount_minor | integer | 否 | What Zinn® charges you per period. `null`, never `0`, when unpriced. |
wholesale_currency | string | 否 | — |
此端点可能返回的错误
401 · 403 · 404 · 429