reseller

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

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

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie reseller.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy pobiera identyfikator Twojej organizacji bezpośrednio z adresu URL jako orgId. Podstaw go w ścieżce — nie ma nagłówka ani parametru zapytania, które mogłyby go zastąpić.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Nazwa	Typ	Wymagane	Co to jest
`orgId (path)`	`Uuid`	Tak	One of your client organizations.
`org_id (query)`	`Uuid`	Nie	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`	Nie	ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`client_org_id`	`Uuid`	Tak	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	Nie	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`	Nie	—
`plan_name`	`string`	Nie	—
`interval`	`string`	Nie	—
`created`	`boolean`	Tak	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`	Nie	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	Nie	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429