reseller

GET `/v1/reseller/clients/{orgId}/plan`

Which plan this client is on, and what it costs you.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.view; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita o ID da sua organização diretamente na URL, como orgId. Substitua-o no caminho — não há cabeçalho ou parâmetro de consulta que sirva como alternativa.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X GET https://api.zinndigital.com/v1/reseller/clients/{orgId}/plan \
  -H "Authorization: Bearer zdk_live_…"

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`orgId (path)`	`Uuid`	Sim	One of your client organizations.
`org_id (query)`	`Uuid`	Não	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`	Não	ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

Resposta

Nome	Tipo	Obrigatório	O que é
`client_org_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	Não	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`	Não	—
`plan_name`	`string`	Não	—
`interval`	`string`	Não	—
`created`	`boolean`	Sim	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`	Não	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 429