commerce

GET /v1/order/config/{planCode}

Everything a signed-in customer configures for one plan.

تمام commerce اینڈ پوائنٹس

تمام ڈویلپر دستاویزات

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس 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