commerce

GET /v1/order/config/{planCode}

Everything a signed-in customer configures for one plan.

Όλα τα τελικά σημεία commerce

Όλα τα έγγραφα προγραμματιστών

Πισtoποίηση

Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Το κλειδί πρέπει να διαθέτει το δικαίωμα billing.view· ένα κλειδί που δεν το διαθέτει απορρίπτεται με 403, όχι 404.

Αυτό το τελικό σημείο δεν δέχεται αναγνωριστικό οργανισμού. Το κλειδί σας προσδιορίζει ήδη τον οργανισμό στον οποίο ανήκει, και η απάντηση περιορίζεται σε αυτόν.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

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.

Παράμετροι

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
planCode (path)stringΝαιThe catalogue code of the plan being configured.

Απάντηση

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
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