reseller

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

Move this client's service onto another package.

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation reseller.provision ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`siteId (path)`	`Uuid`	Oui	Site ID (UUIDv7).
`org_id (query)`	`Uuid`	Non	Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred.
`currency (query)`	`string`	Non	ISO 4217 code the returned wholesale figure is quoted in. Defaults to `USD`.
`interval (query)`	`string`	Non	Billing interval the returned wholesale figure is quoted for. Defaults to `monthly`.

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`plan_code`	`string`	Oui	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…

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`site_id`	`Uuid`	Oui	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`plan_code`	`string`	Oui	—
`plan_name`	`string`	Non	—
`plan_version_id`	`string`	Oui	—
`package_type`	`string`	Non	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`	Oui	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`	Non	What Zinn® will now charge you per period. `null`, never `0`, if unpriced.
`wholesale_currency`	`string`	Non	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422 · 429 · 503