reseller

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

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

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar reseller.provision iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, kuruluş kimliğinizi doğrudan URL içinde orgId olarak alır. Bunu yola ekleyin; bunun yerine geçecek hiçbir başlık veya sorgu parametresi yoktur.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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> }'

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`orgId (path)`	`Uuid`	Evet	One of your client organizations.
`org_id (query)`	`Uuid`	Hayır	Which of YOUR organizations is asking. Required only when you belong to more than one.

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`plan_code`	`string`	Evet	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`	Hayır	Billing interval for the wholesale line. Defaults to `monthly`.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`client_org_id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	Hayır	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`	Hayır	—
`plan_name`	`string`	Hayır	—
`interval`	`string`	Hayır	—
`created`	`boolean`	Evet	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`	Hayır	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	Hayır	—

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 409 · 422 · 429