reseller
POST /v1/reseller/services/{siteId}/package
Move this client's service onto another package.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 reseller.provision 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
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> }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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'.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
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. |
currency (query) | string | 否 | ISO 4217 code the returned wholesale figure is quoted in. Defaults to `USD`. |
interval (query) | string | 否 | Billing interval the returned wholesale figure is quoted for. Defaults to `monthly`. |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
plan_code | string | 是 | 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… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
site_id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
plan_code | string | 是 | — |
plan_name | string | 否 | — |
plan_version_id | string | 是 | — |
package_type | string | 否 | 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 | 是 | 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 | 否 | What Zinn® will now charge you per period. `null`, never `0`, if unpriced. |
wholesale_currency | string | 否 | — |
此端点可能返回的错误
401 · 403 · 404 · 422 · 429 · 503