reseller

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

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

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) reseller.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

A szervezet azonosítójának helye

Ez a végpont magában az URL-ben várja a szervezeted azonosítóját, mégpedig orgId formában. Helyettesítsd be az útvonalba – nincs olyan fejléc vagy lekérdezési paraméter, amely ezt helyettesítené.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

Név	Típus	Kötelező	Mi ez
`orgId (path)`	`Uuid`	Igen	One of your client organizations.
`org_id (query)`	`Uuid`	Nem	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`	Nem	ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

Válasz

Név	Típus	Kötelező	Mi ez
`client_org_id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	Nem	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`	Nem	—
`plan_name`	`string`	Nem	—
`interval`	`string`	Nem	—
`created`	`boolean`	Igen	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`	Nem	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	Nem	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429