reseller

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

Move this client's service onto another package.

Todos los endpoints de reseller

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso reseller.provision; una clave que no lo tenga se rechazará con un código 403, no 404.

Donde va el ID de tu organización

Este endpoint acepta org_id como parámetro de consulta. Omítelo y la llamada abarcará todo tu subárbol de inquilinos; envíalo para acotar la llamada a una sola organización.

El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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

NombreTipoObligatorio¿Qué es esto?
siteId (path)UuidSite ID (UUIDv7).
org_id (query)UuidNoWhich of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred.
currency (query)stringNoISO 4217 code the returned wholesale figure is quoted in. Defaults to `USD`.
interval (query)stringNoBilling interval the returned wholesale figure is quoted for. Defaults to `monthly`.

Cuerpo de la solicitud

NombreTipoObligatorio¿Qué es esto?
plan_codestringThe 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…

Respuesta

NombreTipoObligatorio¿Qué es esto?
site_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
plan_codestring
plan_namestringNo
plan_version_idstring
package_typestringNoThe 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_idstringThe 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_minorintegerNoWhat Zinn® will now charge you per period. `null`, never `0`, if unpriced.
wholesale_currencystringNo

Errores que este endpoint puede devolver

401 · 403 · 404 · 422 · 429 · 503