reseller
GET /v1/reseller/services/{siteId}/package
Which packages this client's service could move onto, and what each costs you.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл reseller.view; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/reseller/services/{siteId}/package \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
The upgrade/downgrade picker your billing panel renders. Every plan this service could move to, each already scored against what the client is actually using, with the refusals applied — so a downgrade that would strand them over their own disk or database allowance is reported as ineligible here rather than failing when your customer presses the button. Requires reseller.view. Two prices per option, and they answer different questions. wholesale_amount_minor is what Zinn® charges you for a period of that plan, after your programme's discount. sell_amount_minor is what you charge your client — your own price-list row where you have authored one, otherwise our list price plus your default markup. Both are integer minor units with an ISO currency code, and both are null — never 0 — when the catalogue holds no price in the currency asked for: a zero is a number a billing panel will invoice. blocked_reason is a stable code, never prose: usage_exceeds · account_over_limit · platform_mismatch · no_price · unknown_package_type · different_target · no_package_type. Your panel renders it in your own language. blocked_detail carries the numbers behind usage_exceeds so a screen can say which limit and by how much. changeable: false means the surface is shut whatever plan is chosen, and reason says which: no_subscription, not_billable, no_package_type, or subscription_not_live. ⛔ shared_subscription is retired (2026-09-08) and this surface no longer returns it. It shut the screen whenever one subscription covered several of a client's sites — which is what a multi-site plan is — so a reseller's panel could not offer an upgrade to exactly the clients most likely to want one. A plan covering several sites is now moved for all of them together.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
siteId (path) | Uuid | Так | Site ID (UUIDv7). |
org_id (query) | Uuid | Ні | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404… |
currency (query) | string | Ні | ISO 4217 code the two prices are quoted in. Defaults to USD. |
interval (query) | string | Ні | Billing interval the prices are quoted for. Defaults to monthly. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
current_plan_code | string | Ні | — |
current_plan_name | string | Ні | — |
changeable | boolean | Так | False when the surface is shut whatever plan is picked — see reason. Your panel should hide the upgrade control rather than offer one that cannot work. |
reason | string | Ні | Why, when changeable is false. A stable code: no_subscription · not_billable · no_package_type · subscription_not_live. ⛔ shared_subscription is retired (2026-09-08)… |
options | ResellerServicePackageOption[] | Так | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 429 · 503