reseller

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

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

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس reseller.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

جہاں آپ کی تنظیم کی آئی ڈی آتی ہے

یہ اینڈ پوائنٹ URL میں ہی آپ کی تنظیم کی شناخت (organization id) بطور orgId لیتا ہے۔ اسے پاتھ میں تبدیل کریں — ایسا کوئی ہیڈر یا کیوری پیرامیٹر نہیں ہے جو اس کی جگہ لے سکے۔

آپ کی تنظیم کی آئی ڈی آپ کے ڈیش بورڈ پر API کیز کی سکرین پر، خود کلید کے ساتھ موجود ہوتی ہے۔ یہ آپ کی کی جانے والی ہر کال میں ایک ہی آئی ڈی ہوتی ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو 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