reseller

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

Move this client's service onto another package.

همه نقاط پایانی reseller

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز reseller.provision باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی org_id را به عنوان یک پارامتر پرس‌وجو می‌پذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجاره‌ای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی 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_codestringبله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_idUuidبلهUUIDv7 identifier — sortable by creation time (docs/02 §8).
plan_codestringبله
plan_namestringخیر
plan_version_idstringبله
package_typestringخیر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_idstringبله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_minorintegerخیرWhat Zinn® will now charge you per period. `null`, never `0`, if unpriced.
wholesale_currencystringخیر

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 422 · 429 · 503