Start secure checkout
start_checkoutUse only once the customer has decided to buy ("I'll take it", "how do I buy?"): the checkout handoff. Returns the buy_url to give the customer, the final price and a ready-to-send checkout block (next_step, payment_methods, delivery) — on the page they press "Get it" and pay securely. No account needed; the eSIM is delivered on screen and by e-mail right after payment. No in-chat order tracking, no discount codes. For prices while the customer is still comparing, use quote_esim.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| gb | Yes | Data pool in whole GB (1–100). | |
| days | Yes | Validity days (1–90). | |
| bucket | No | Optional language-region bucket the customer shops in, e.g. en-gb, de-de (sets currency and link locale). Defaults from language. | |
| currency | No | ||
| language | No | ISO language of the conversation, e.g. en, de, ja. Localizes country names and sets the language/currency of links and prices. | |
| networks | No | Optional: operator names (or codes) from get_networks to include. Omit = the cheapest network of the country. The dearest included network sets the data price and every network beyond the first adds a small fee. | |
| destination | Yes | Country in ANY language or its ISO code, e.g. "Japan", "Japon", "jp". Map a city to its country first. One country per eSIM. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| iso | No | ISO 3166-1 alpha-2, lower case. | |
| days | No | Validity in days, counted from the first connection at the destination. | |
| note | No | Present when something about the request had to be adjusted — read it to the customer. | |
| price | Yes | FULL price of this configuration in currency — the amount paid. Not per day, not per GB. | |
| topup | No | How the customer adds data or days to this eSIM later (not through the tools). | |
| buy_url | Yes | Configurator pre-set to exactly this configuration. Use verbatim. | |
| data_gb | No | Total data pool for the whole validity (whole GB). Not per day. | |
| hotspot | No | ||
| message | No | A ready-to-send line for the customer. | |
| currency | Yes | ||
| delivery | No | How and when the eSIM arrives. | |
| networks | No | Operator names included in this eSIM. | |
| next_step | Yes | What the customer does now: open buy_url, press "Get it", pay. | |
| destination | No | Resolved country name (localized). | |
| price_basis | No | ||
| price_is_final | No | ||
| payment_methods | No | ||
| activation_trigger | No | ||
| networks_unmatched | No | Present when a requested network does not exist in this country: those names. The quote then uses the networks listed in networks. |