reseller

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

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

Authentication

Send an API key as a bearer token. The key must carry the reseller.view permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes your organisation id in the URL itself, as orgId. Substitute it into the path — there is no header or query parameter that will do instead.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the 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

Name	Type	Required	What it is
`orgId (path)`	`Uuid`	Yes	One of your client organizations.
`org_id (query)`	`Uuid`	No	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`	No	ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

Response

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

Errors this endpoint can return

401 · 403 · 404 · 429