reseller

POST `/v1/reseller/services/{siteId}/package`

Move this client's service onto another package.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.provision; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

Performs the upgrade or downgrade your panel just sold. The vendor package is moved, the client's entitlements follow it, and on our own fleet the box is given the new plan's quota. Requires `reseller.provision`. ⛔ **Your client is not charged by us, and cannot be.** Under a reseller programme Zinn® bills *you* — the new plan appears on your next wholesale statement, because that statement is built from your clients' live subscriptions — and you bill your client through your own panel, which has already taken their money for this upgrade. There is no second charge and no card is touched. That is why this operation exists beside `changeSitePlan` rather than instead of it: the customer-facing one mints an order against the client organization, which under a reseller holds no payment instrument at all. Takes a plan **code**, not a version id. A code is what your admin typed into the product's module settings and it stays valid for years; the engine always resolves the newest active version of it, so a plan we have since re-priced cannot be bought at its old price by a panel nobody has updated. Every refusal `listResellerServicePackages` reports is applied again here on fresh numbers, so a downgrade that has become unsafe since the picker was rendered is still refused. Repeating an identical request is safe and is the documented recovery: each step is idempotent, and a service already on the target plan is a `422` saying so rather than a second move. `422` for an unknown plan code, for a plan on a different product line or infrastructure, and for a downgrade the client's usage does not fit. `503` when the hosting platform behind the service cannot change a package type at all. `404` for a service that is not one of your clients'.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`siteId (path)`	`Uuid`	Sim	Site ID (UUIDv7).
`org_id (query)`	`Uuid`	Não	Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred.
`currency (query)`	`string`	Não	ISO 4217 code the returned wholesale figure is quoted in. Defaults to `USD`.
`interval (query)`	`string`	Não	Billing interval the returned wholesale figure is quoted for. Defaults to `monthly`.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`plan_code`	`string`	Sim	The plan to move onto, by code. The newest active version of it is always what gets applied, so a plan we have re-priced since your product was configured cannot be sold at…

Resposta

Nome	Tipo	Obrigatório	O que é
`site_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`plan_code`	`string`	Sim	—
`plan_name`	`string`	Não	—
`plan_version_id`	`string`	Sim	—
`package_type`	`string`	Não	The vendor package template the service now sits on. Empty on our own fleet, where a plan names no template because there is no vendor — the plan is its entitlement set, appli…
`subscription_id`	`string`	Sim	The client's new subscription. This is the row your next wholesale statement is built from, which is how the change reaches your bill.
`wholesale_amount_minor`	`integer`	Não	What Zinn® will now charge you per period. `null`, never `0`, if unpriced.
`wholesale_currency`	`string`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429 · 503