reseller

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

Which packages this client's service could move onto, and what each costs you.

Wszystkie punkty końcowe reseller

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie reseller.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X GET https://api.zinndigital.com/v1/reseller/services/{siteId}/package \
  -H "Authorization: Bearer zdk_live_…"

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
siteId (path)UuidTakSite ID (UUIDv7).
org_id (query)UuidNieWhich 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)stringNieISO 4217 code the two prices are quoted in. Defaults to USD.
interval (query)stringNieBilling interval the prices are quoted for. Defaults to monthly.

Odpowiedź

NazwaTypWymaganeCo to jest
current_plan_codestringNie
current_plan_namestringNie
changeablebooleanTakFalse 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.
reasonstringNieWhy, when changeable is false. A stable code: no_subscription · not_billable · no_package_type · subscription_not_live. ⛔ shared_subscription is retired (2026-09-08)…
optionsResellerServicePackageOption[]Tak

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429 · 503