commerce

GET /v1/order/config/{planCode}

Everything a signed-in customer configures for one plan.

सबै commerce इन्डपइन्टहरू

सबै विकासकर्ता कागजातहरू

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग billing.view अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।

यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

curl -X GET https://api.zinndigital.com/v1/order/config/{planCode} \
  -H "Authorization: Bearer zdk_live_…"

लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्

विवरणहरू

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.

प्यारामिटरहरू

नामप्रकारआवश्यकयो के हो
planCode (path)stringहुन्छThe catalogue code of the plan being configured.

प्रतिक्रिया

नामप्रकारआवश्यकयो के हो
plan_codestringहुन्छ
plan_namestringहुन्छ
plan_idstringहुन्छThe plan's stable identity — what a URL or an analytics event refers to.
plan_version_idstringहुन्छ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_versionintegerहुन्छ
product_linestringहुन्छ
product_line_namestringहुन्छ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.
currencystringहुन्छ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…
termsOrderTerm[]हुन्छCheapest per month first, which is what default_interval names.
default_intervalstringहुन्छ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_daysobjectहुन्छ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_domainsintegerहुन्छ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_tldsstring[]हुन्छ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_yearsinteger[]हुन्छ
regionsOrderRegion[]हुन्छ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…
specOrderSpecItem[]हुन्छ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…
addonsOrderAddon[]हुन्छ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…

यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू

401 · 403 · 404