reseller
GET /v1/reseller/clients/{orgId}/plan
Which plan this client is on, and what it costs you.
認証
ベアラー トークンとして API キーを送信します。キーには reseller.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 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