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