API reference

eSIM

Coverage by country and region, plans at your net price, and orders with their activation data and live usage.

Operations

Operation	What it does	Scope
GET/v1/esim/countries	Countries with eSIM coverage	`esim:read`
GET/v1/esim/regions	Regional eSIM bundles	`esim:read`
GET/v1/esim/plans	Plans at your net price	`esim:read`
GET/v1/esim/plans/{planId}	One plan at your net price	`esim:read`
GET/v1/esim/orders	Your eSIM orders, newest first	`esim:read`
POST/v1/esim/orders	Order an eSIM — who pays follows your key	`esim:order`
GET/v1/esim/orders/{id}	One order with its activation data	`esim:read`
GET/v1/esim/orders/{id}/usage	Live data usage	`esim:read`

A key that lacks one of these scopes is refused with 403 insufficient_scope, and error.missingScope names the one it was missing. Scopes are fixed when the key is issued.

Shared across these operations

The error envelope and the full list of error types are the same for every operation in the API, as are the object schemas the responses are built from. Neither is repeated per page.