reseller

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

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

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar reseller.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, kuruluş kimliğinizi doğrudan URL içinde orgId olarak alır. Bunu yola ekleyin; bunun yerine geçecek hiçbir başlık veya sorgu parametresi yoktur.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`orgId (path)`	`Uuid`	Evet	One of your client organizations.
`org_id (query)`	`Uuid`	Hayır	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`	Hayır	ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`client_org_id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	Hayır	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`	Hayır	—
`plan_name`	`string`	Hayır	—
`interval`	`string`	Hayır	—
`created`	`boolean`	Evet	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`	Hayır	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	Hayır	—

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 429