reseller

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

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

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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