commerce
GET /v1/order/config/{planCode}
Everything a signed-in customer configures for one plan.
Doğrulama
API açarını bearer token kimi göndərin. Açar billing.view icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
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/order/config/{planCode} \
-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 in-app twin of getPublicOrderConfig, and it reads the same function: two computations of "what can I configure on this plan" is how the public funnel and the console come to disagree about whether a plan includes a free domain. The one real difference is why this route exists: it includes the product lines the owner ruled sellable only inside the app (email for an external domain, 2026-08-16), which are absent from every anonymous surface. It is a separate authenticated route rather than a query parameter, because a parameter an anonymous caller can set is not a visibility control. Authenticated but not tenant-scoped: the answer is a statement about what the platform sells, not about the caller's estate. Requires billing.view.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
planCode (path) | string | Bəli | The catalogue code of the plan being configured. |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
plan_code | string | Bəli | — |
plan_name | string | Bəli | — |
plan_id | string | Bəli | The plan's stable identity — what a URL or an analytics event refers to. |
plan_version_id | string | Bəli | The purchasable identifier: what a hosting_plan cart line pins. Not plan_id — a price change mints a new version rather than mutating the sold one, so this value changes… |
plan_version | integer | Bəli | — |
product_line | string | Bəli | — |
product_line_name | string | Bəli | The line's display name from the engine's one source table, so a client never has to render a raw code to a customer. |
currency | string | Bəli | What everything on this payload is priced in. It may differ from the currency asked for: a currency with no derived price row yet falls back to USD and says so here rather… |
terms | OrderTerm[] | Bəli | Cheapest per month first, which is what default_interval names. |
default_interval | string | Bəli | The cadence to select on first render — derived as the cheapest per month rather than typed beside the price table. A typed default is a comment that happens to run: correct… |
trial_days | object | Bəli | The free trial this plan offers, or null for none. A trial takes no card and starts immediately, so the button beneath the configuration has to say "start trial" rather than… |
included_domains | integer | Bəli | How many domain registrations the plan includes free — the "use the free domain this plan includes" branch. 0 is the common case: render that branch only when the allowance is… |
included_domain_tlds | string[] | Bəli | Which extensions the free registration may be spent on. Empty alongside a non-zero included_domains means the plan grants any offered TLD. |
domain_term_years | integer[] | Bəli | — |
regions | OrderRegion[] | Bəli | The data centres a site on this plan may be created in. Empty is a real answer — the Footprint-Free line offers no region by owner ruling, because a PBN customer is… |
spec | OrderSpecItem[] | Bəli | The read-only "what is included" panel, ordered for display. Not a filtered allow-list: every resolved entitlement appears, so a capability added to the catalogue tomorrow is… |
addons | OrderAddon[] | Bəli | The services offered on this product line and deliverable today — a PBN addon never appears on a mainstream plan, and an addon whose fulfilment handler has been withdrawn… |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404