public
GET /v1/public/order/config/{planCode}
Everything a buyer configures for one plan, in one call.
身份验证
此端点是公开的。它不需要任何凭据或组织——这是我们自己的营销网站和 AI 问答引擎所读取的内容。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/public/order/config/{planCode}已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Owner ruling 2026-09-09, on a competitor's order flow: "when you buy something it has a clear config page for that hosting where all the options reside nice and neatly including the domain and things … we should have these config pages in full too inside our app, so you select the hosting type then they config for it both public and in the app". One call by design, not as an optimisation. A configuration page assembled from five endpoints renders in five stages, and the two that matter most — the free-domain allowance and the eligible addons — would arrive last, after the visitor has already decided. Everything here is derived from live rows: the terms and their saving are the plan's own two prices subtracted, default_interval is the cheapest per month rather than a literal, the free-domain allowance and its TLDs are the included_domains entitlement, the regions come from the activated data centres for this product line (empty on Footprint-Free by owner ruling), and the addons are the extras Extra.is_eligible_for admits on this line. A choice the platform cannot apply is deliberately absent. There is no PHP-version option: measured on the live catalogue, no plan carries a PHP entitlement — PHP is chosen per site after provisioning — so a picker here would be a control that changes nothing. Lines the owner ruled sellable only inside the app are not served here; the signed-in console reads the same shape from getOrderConfig.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
planCode (path) | string | 是 | The catalogue code of the plan being configured (pbn_5, …). |
currency (query) | string | 否 | ISO-4217 code to price this response in — the same assertion X-Zinn-Currency makes, in a form a caller that cannot send custom headers can use. The public funnel is exactly that… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
plan_code | string | 是 | — |
plan_name | string | 是 | — |
plan_id | string | 是 | The plan's stable identity — what a URL or an analytics event refers to. |
plan_version_id | string | 是 | 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 | 是 | — |
product_line | string | 是 | — |
product_line_name | string | 是 | 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 | 是 | 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[] | 是 | Cheapest per month first, which is what default_interval names. |
default_interval | string | 是 | 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 | 是 | 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 | 是 | 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[] | 是 | 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[] | 是 | — |
regions | OrderRegion[] | 是 | 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[] | 是 | 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[] | 是 | 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… |
此端点可能返回的错误
404 · 429