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 կարգավիճակով:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այս վերջնակետը որպես orgId ընդունում է ձեր կազմակերպության ID-ն հենց URL-ում: Տեղադրեք այն ուղու մեջ. չկա որևէ վերնագիր կամ հարցման պարամետր, որը կարող է փոխարինել դրան:

Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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