reseller

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

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

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění reseller.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přebírá ID vaší organizace přímo v URL jako orgId. Dosaďte jej do cesty – neexistuje žádná hlavička ani parametr dotazu, které by to udělaly místo toho.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`orgId (path)`	`Uuid`	Ano	One of your client organizations.
`org_id (query)`	`Uuid`	Ne	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`	Ne	ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

Odpověď

Název	Typ	Požadováno	Co to je
`client_org_id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	Ne	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`	Ne	—
`plan_name`	`string`	Ne	—
`interval`	`string`	Ne	—
`created`	`boolean`	Ano	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`	Ne	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	Ne	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429