reseller

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

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

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie reseller.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Waar je organisatie-id komt te staan

Dit eindpunt gebruikt je organisatie-id rechtstreeks in de URL als orgId. Vervang dit in het pad; er is geen header of queryparameter die dit kan overnemen.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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.

Parameters

Naam	Type	Verplicht	Wat dit is
`orgId (path)`	`Uuid`	Ja	One of your client organizations.
`org_id (query)`	`Uuid`	Nee	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`	Nee	ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

Reactie

Naam	Type	Verplicht	Wat dit is
`client_org_id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	Nee	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`	Nee	—
`plan_name`	`string`	Nee	—
`interval`	`string`	Nee	—
`created`	`boolean`	Ja	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`	Nee	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	Nee	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 429