reseller

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

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

Doğrulama

API açarını bearer token kimi göndərin. Açar reseller.view icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.

Təşkilatınızın identifikatorunun yerləşdiyi yer

Bu son nöqtə təşkilatınızın identifikatorunu birbaşa URL-də orgId kimi qəbul edir. Onu yola daxil edin — bunun əvəzinə işləyəcək heç bir başlıq və ya sorğu parametri yoxdur.

Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`orgId (path)`	`Uuid`	Bəli	One of your client organizations.
`org_id (query)`	`Uuid`	Xeyr	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`	Xeyr	ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

Cavab

Ad	Tip	Tələb olunur	Nədir
`client_org_id`	`Uuid`	Bəli	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	Xeyr	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`	Xeyr	—
`plan_name`	`string`	Xeyr	—
`interval`	`string`	Xeyr	—
`created`	`boolean`	Bəli	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`	Xeyr	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	Xeyr	—

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 429