eSIM API Reference

Returns the data plans you can buy, filterable by region, country, validity and price.

Returns one plan with its coverage, allowance, validity and price.

Returns the countries with plans available to you.

Returns the multi-country regions with plans available to you.

Buys a plan and begins provisioning. Returns immediately with an order to poll; delivery completes asynchronously.

Returns an order's status and, once delivered, the eSIMs it produced.

Returns your eSIM orders, newest first.

Returns orders that have not reached a final state yet.

Sends the order confirmation email again to the address on the order. Rate limited; repeating it is safe. This operation is safe to repeat: repeating it returns the existing state and performs no further action.

Returns the eSIMs an order produced, with their installation details.

Returns how much data, voice and SMS allowance remains on an eSIM.

Returns localized installation steps and the activation material for an eSIM.

Returns every eSIM you hold, across all orders.

Returns one eSIM with its status and installation details.

Returns the top-up packages compatible with an eSIM.

Adds a package to an existing eSIM. Returns an order to poll.

Returns the packages currently applied to an eSIM.

Returns your scheduled orders and their due dates.

Schedules a purchase for a future date. Nothing is charged until it runs.

Cancels a scheduled order before its due date. Repeating this is safe. This operation is safe to repeat: repeating it returns the existing state and performs no further action.

Opens a refund request for a delivered order. Requests are reviewed; this does not move money by itself.

Returns your refund requests and their review state.

Withdraws a refund request that is still pending. Repeating this is safe. This operation is safe to repeat: repeating it returns the existing state and performs no further action.