reseller
GET /v1/reseller/clients/{orgId}/plan
Which plan this client is on, and what it costs you.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز reseller.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی، شناسه سازمان شما را مستقیماً در خود URL به صورت 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