reseller

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

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

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione reseller.provision; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

L'ID della tua organizzazione va qui

Questo endpoint accetta l'ID della tua organizzazione direttamente nell'URL come orgId. Sostituiscilo nel percorso: non sono presenti intestazioni o parametri di query alternativi.

L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`orgId (path)`	`Uuid`	Sì	One of your client organizations.
`org_id (query)`	`Uuid`	No	Which of YOUR organizations is asking. Required only when you belong to more than one.

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`plan_code`	`string`	Sì	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`	No	Billing interval for the wholesale line. Defaults to `monthly`.

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`client_org_id`	`Uuid`	Sì	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	No	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`	No	—
`plan_name`	`string`	No	—
`interval`	`string`	No	—
`created`	`boolean`	Sì	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`	No	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	No	—

Errori che questo endpoint può restituire

401 · 403 · 404 · 409 · 422 · 429