reseller
GET /v1/reseller/clients/{orgId}/plan
Which plan this client is on, and what it costs you.
인증
Bearer 토큰으로 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