reseller

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

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

すべての reseller エンドポイント

すべての開発者向けドキュメント

認証

ベアラー トークンとして API キーを送信します。キーには reseller.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

組織 ID を入力する場所

このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。

組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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_codestringいいえ
current_plan_namestringいいえ
changeablebooleanはい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.
reasonstringいいえ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)…
optionsResellerServicePackageOption[]はい

このエンドポイントが返すエラー

401 · 403 · 404 · 429 · 503