reseller

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

Put a client on a plan — call this before provisioning their first service.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте reseller.provision рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Ұйымыңыздың идентификаторы орналасатын жер

Бұл соңғы нүкте URL мекенжайының өзінде ұйымыңыздың идентификаторын orgId ретінде қабылдайды. Оны жолға қойыңыз — мұны алмастыратын басқа тақырып немесе сұрау параметрі жоқ.

Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

curl -X POST https://api.zinndigital.com/v1/reseller/clients/{orgId}/plan \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "plan_code": <string> }'

Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз

Мәліметтер

Grants the client organization the plan your product sells, and returns the `subscription_id` to pass to `createSite`. Requires `reseller.provision`. ⛔⛔ **A provisioning module MUST call this before `createSite`, and omitting it is a silent, total loss of the invoice.** A newly created organization has no subscription, and `createSite` has no plan field — so a site provisioned without one lands with no plan at all. Your wholesale statement is built from your clients' live subscriptions, so there is no line for that service and Zinn® bills you nothing while the hosting runs; the client inherits no entitlements, so no quota is applied to their box; and `changeResellerServicePackage` has nothing to change, so an upgrade you sell cannot be performed. Nothing anywhere reports this — the site provisions and serves perfectly. **Your client is never invoiced by Zinn®.** The subscription is granted comped: it exists to carry entitlements and to put a line on *your* wholesale statement, and our renewal billing skips it. You bill your client; we bill you. **A second service for the same client.** On the **same** plan this is a no-op and returns `200` with `created: false` — the plan's own site allowance covers the extra site, so nothing further is granted and a retried provision cannot disturb the subscription it is re-establishing. On a **different** plan it is refused `422`, because replacing the live plan would leave one of the two services unbilled. Either sell both on the same plan, or set the client up as a separate client record. To move a client to a different plan, use `changeResellerServicePackage` on the service. `422` for an unknown plan code and for a plan that is not for sale. `409` when the client's existing usage does not fit the plan being granted, with the real numbers.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`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.

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`plan_code`	`string`	Иә	The plan to put this client on, by code — the value your product's module settings carry. The newest active version of it is always what is granted.
`interval`	`string`	Жоқ	Billing interval for the wholesale line. Defaults to `monthly`.

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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 · 409 · 422 · 429

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