commerce
GET /v1/order/config/{planCode}
Everything a signed-in customer configures for one plan.
அங்கீகாரம்
பியரர் டோக்கனாக (bearer token) ஒரு API விசையை அனுப்பவும். அந்த விசை billing.view அனுமதியைக் கொண்டிருக்க வேண்டும்; அது இல்லாத விசை 404 அல்ல, 403 குறியீட்டுடன் மறுக்கப்படும்.
இந்த எண்ட்பாயிண்டிற்கு எந்த அமைப்பு ஐடியும் (organisation id) தேவையில்லை. உங்கள் விசை (key) அது எந்த அமைப்புக்குரியது என்பதை ஏற்கனவே அடையாளம் காட்டுகிறது, மேலும் பதிலானது அதற்கேற்ப வரம்பிடப்பட்டுள்ளது.
முயன்று பார்
கோண அடைப்புக்குறிகளில் உள்ள எதையும் உங்கள் சொந்த மதிப்புகளுடன் மாற்றவும், மேலும் விசை பிளேஸ்ஹோல்டரை உங்கள் டாஷ்போர்டில் உள்ள விசையுடன் மாற்றவும்.
curl -X GET https://api.zinndigital.com/v1/order/config/{planCode} \
-H "Authorization: Bearer zdk_live_…"உள்நுழைந்துள்ளீர்களா? உங்கள் டேஷ்போர்டில் உள்ள ஏபிஐ கன்சோல் உங்கள் உண்மையான நிறுவன ஐடி மற்றும் உங்கள் சொந்த சாவியை நிரப்புகிறது, மேலும் நேரலை ஏபிஐக்கு எதிராக கோரிக்கையை இயக்குகிறது, இதனால் நீங்கள் உண்மையான பதிலைக் காண முடியும். இந்த எண்ட்மார்க்கை ஏபிஐ கன்சோலில் திறக்கவும்
விவரங்கள்
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_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… |
இந்த எண்ட்ஸ்பாயிண்ட் திரும்ப அனுப்பக்கூடிய பிழைகள்
401 · 403 · 404