reseller

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

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

Bütün reseller nöqtələri

Doğrulama

API açarını bearer token kimi göndərin. Açar reseller.view icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.

Təşkilatınızın identifikatorunun yerləşdiyi yer

Bu son nöqtə sorğu parametri kimi org_id qəbul edir. Onu buraxın və sorğu bütün kirayə alt ağacınızı əhatə etsin; sorğunu bir təşkilatla məhdudlaşdırmaq üçün onu göndərin.

Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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`, `shared_subscription` (one subscription covers several of that client's sites, so moving it here would change what the others are entitled to), `not_billable`, or `no_package_type`.

Parametrlər

AdTipTələb olunurNədir
siteId (path)UuidBəliSite ID (UUIDv7).
org_id (query)UuidXeyrWhich 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 r…
currency (query)stringXeyrISO 4217 code the two prices are quoted in. Defaults to `USD`.
interval (query)stringXeyrBilling interval the prices are quoted for. Defaults to `monthly`.

Cavab

AdTipTələb olunurNədir
current_plan_codestringXeyr
current_plan_namestringXeyr
changeablebooleanBəliFalse 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.
reasonstringXeyrWhy, when `changeable` is false. A stable code: `no_subscription` · `shared_subscription` · `not_billable` · `no_package_type`.
optionsResellerServicePackageOption[]Bəli

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 429 · 503