reseller

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

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

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu reseller.view; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka prihvaća ID vaše organizacije u samom URL-u, kao orgId. Zamijenite ga u stazi — ne postoji zaglavlje ili parametar upita koji će umjesto toga poslužiti.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`orgId (path)`	`Uuid`	Da	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`.

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`client_org_id`	`Uuid`	Da	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`	Da	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	—

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 429