Get payment links
start_checkoutPlaces an eSIM order on a connected Simvito account and returns card/wallet and PayPal payment links with the total, discount, and order number; nothing is charged until the user pays.
Instructions
When the user decides to buy and their Simvito account is connected: places the order on their account and returns two payment links to give them exactly as returned, a secure payment page for cards, Apple Pay, Google Pay and local wallets, and PayPal (when available for this order), with the total, any discount and an order number. Nothing is charged until the user pays on one of those pages. Pass items for up to 5 different plans from search_plans or plan_trip (up to 10 eSIMs in all), or plan_id and quantity for one plan. If the account isn't connected, use get_buy_link instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | No | The plans to buy, each with its quantity. | |
| device | No | Where the user will open the payment link, if you know: 'phone' or 'computer' | |
| locale | No | Language of the conversation, as a simvito.com language code ('en', 'ja', 'zh-CN', 'es'…); names and links follow it. Defaults to 'en'. | |
| plan_id | No | Shorthand for a single plan: plan_id returned by search_plans or plan_trip (instead of items) | |
| currency | No | The user's currency (ISO 4217) for prices: USD, EUR, GBP, HKD, CNY, SGD, JPY, AUD, NZD, CAD, BRL, IDR, MYR, PHP, THB, KRW, PLN, CHF, SEK, TWD, VND, TRY, SAR, AED, ILS. Defaults to USD. | |
| quantity | No | With plan_id: number of eSIMs (one per traveller). Defaults to 1. | |
| destination | No | The destination search_plans returned with the plan(s); can also be given on each item. | |
| confirmations | No | Codes from a previous confirmation_required result that the user explicitly agreed to after seeing each text. Never fill these in for the user. | |
| expected_unit_amount | No | With plan_id, only after price_changed: the new unit price the user accepted. Otherwise omit; the quoted price is used. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | ||
| items | Yes | ||
| links | No | ||
| total | No | ||
| coupon | No | ||
| status | Yes | ||
| policies | No | ||
| quantity | Yes | ||
| required | No | ||
| expires_at | No | ||
| list_total | No | ||
| checkout_id | No | ||
| price_changes | No | ||
| order_display_id | No |