Create a checkout link
create_checkout_linkA checkout URL on esimpass.com with one plan already selected. It does not pay or place an order: the traveller opens it, enters their email and pays (card, Apple Pay, Google Pay, PayPal or crypto). Minutes later the confirmation page has an Install button (one tap on iPhone and Android), a QR code and a private eSIM link. Takes a plan name as get_plans returns it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | Yes | The plan name from get_plans, e.g. "7 Days - 3GB Data" or "Unlimited - 10 Days". | |
| currency | No | ISO 4217 code to price in, e.g. "EUR", "USD", "GBP". Defaults to this site's currency. | |
| quantity | No | How many eSIMs (one per traveller). Default 1. | |
| travel_end | No | Unlimited plans only, optional: last travel day, YYYY-MM-DD. | |
| destination | Yes | The destination: a slug from search_destinations ("esim-japan", "esim-europe", "esim-tokyo") or its English name ("Japan"). | |
| partner_code | No | Optional eSIMpass Partner Program code (letters and digits): the sale is credited to that partner. | |
| travel_start | No | Unlimited plans only, optional: first travel day, YYYY-MM-DD. For some destinations the plan starts on this date. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | Yes | ||
| total | Yes | ||
| currency | Yes | ||
| quantity | Yes | ||
| next_step | No | ||
| unit_price | Yes | ||
| destination | Yes | ||
| checkout_url | Yes |