reseller

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

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

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د reseller.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

چیرته چې ستاسو د سازمان آی ډي ځي

دا پای ټکی ستاسو د سازمان آی ډي په خپله په URL کې د orgId په توګه اخلي. دا په لاره کې ځای پرځای کړئ — هیڅ سرلیک یا پوښتنې پیرامیټر شتون نلري چې د دې پرځای کار وکړي.

ستاسو د سازمان آی ډي ستاسو په ډشبورډ کې د API کېلي پر سکرین، خپله د کېلي څنګ ته شتون لري. دا په هره هغه غوښتنه کې چې تاسو یې کوئ، ورته آی ډي وي.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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.

پارامترونه

نوم	ډول	اړین	دا څه شی دی
`orgId (path)`	`Uuid`	هو	One of your client organizations.
`org_id (query)`	`Uuid`	نه	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`	نه	ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

ځواب

نوم	ډول	اړین	دا څه شی دی
`client_org_id`	`Uuid`	هو	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	نه	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`	نه	—
`plan_name`	`string`	نه	—
`interval`	`string`	نه	—
`created`	`boolean`	هو	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`	نه	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	نه	—

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 429

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