Search eSIM plans
Searches eSIM destinations and returns them with their plans, one page at a time.
Searches eSIM destinations and returns them with their plans, one page at a time.
Returns { items, pagination }. countryCode keeps the destinations whose coverage includes that
country, so local, regional and global destinations can match; category and region select
destinations, and validityDays and isUnlimited select plans within them. Pages count destinations
with an orderable plan. With iccid it returns the plans that can top up that eSIM instead, under its
destination, and takes no filter other than currency (400 / 10001, NOT_ALLOWED); an unknown or
foreign ICCID gives 404 / 10004. Prices are indicative, in currency.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
countryCode?stringOptional ISO 3166-1 alpha-2 country, in either case: keeps the destinations whose coverage includes it, regional and global ones too. A blank value is rejected.
category?stringKeep local, regional or global destinations.
"local""regional""global"region?stringKeep the destinations of this region, in display or slug form, for example North America or north-america.
validityDays?integerKeep the plans valid for exactly this many days; at least 1.
int32isUnlimited?booleanKeep the unlimited (true) or the limited (false) plans.
iccid?stringTop-up search: the ICCID (18 to 22 digits) of your eSIM to list the plans that can top it up. No other filter than currency is allowed with it.
currency?stringPrice currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at currency, reason NOT_SUPPORTED.
page?integerPage number, from 1; default 1.
int32limit?integerPage size, 1 to 100; default 10.
int32OK
- response
A page of destinations; pagination.totalCount counts destinations that have an orderable offer.
items*array<>pagination*Paging of a list response.
curl -X GET 'https://api.sandbox.openroam.com/v1/esims/search?countryCode=FR&category=regional®ion=Europe&validityDays=7&isUnlimited=false¤cy=USD&page=1&limit=10'{ "items": [ { "id": "destn_k3m7q2t5w4y6b2d4f6h3j5n7pq", "name": "Europe", "countryCode": null, "category": "regional", "logoUrl": "https://cdn.openroam.test/esims/europe.png", "description": null, "offers": [ { "publicId": "esim_eu_3gb_7d", "name": "Europe 3 GB 7 days", "description": null, "price": { "amount": 25, "currency": "USD" }, "requiredInputs": [ { "name": "isInstant", "type": "boolean", "required": false, "description": "Defaults to true, which creates the eSIM when the order is fulfilled. False delivers an entitlement, and the eSIM is created later through provisioning." } ], "details": { "validityDays": 7, "data": { "amount": 3072, "unit": "MB", "isUnlimited": false, "label": "3 GB" }, "voice": null, "sms": null, "apn": { "apn": "internet", "apnUsername": null, "apnPassword": null }, "properties": { "withKyc": false, "withTopUp": true, "withHotspot": true, "withDataRoaming": true, "withSubscription": false, "withDestinationInstall": false, "withUsageCheck": true, "technology": "eSIM", "activation": "first-use", "charge": "one-time" }, "restrictions": { "throttle": false, "throttleSpeed": null, "throttleUnit": null, "throttleThreshold": null, "throttleThresholdUnit": null, "expireInDays": 30 }, "notes": [ "Data only. Calls and SMS are not included." ], "plan": null } } ], "details": { "destinationCode": "EU", "region": "Europe", "coverage": [ { "countryCode": "DE", "name": "Germany", "networks": [ "4G" ], "carriers": [ "Telekom" ] }, { "countryCode": "FR", "name": "France", "networks": [ "4G", "5G" ], "carriers": [ "Orange" ] }, { "countryCode": "IT", "name": "Italy", "networks": [ "4G" ], "carriers": [ "TIM" ] } ] } } ], "pagination": { "currentCount": 1, "totalCount": 1, "skip": 0, "limit": 10, "hasMore": false, "page": 1, "totalPages": 1 }}Quote eSIMs POST
Prices the order body with current prices, without placing an order. Takes the same body as order and, as the order does, checks each item completely (its inputs, its `publicId` and its price) before the next one, in request order. The first failure aborts the quote, and an item error is named at `items[i]`, for example 409 / 11002 at `items[i].inputs.maxPrice` when the current price is above it. An eSIM has no monetary value, so `inputs.value` is an unknown member (400 / 10001). An unknown or foreign `inputs.iccid` gives 404 / 10004. A quote reserves nothing and does not expire.
Send an SMS to an eSIM POST
Sends a text message to one of your eSIMs. Takes `{ message }`, which must not be empty, and returns `{ iccid }` only when the message was sent. An eSIM whose plan cannot be sent messages this way gives 422 / 22000 (`ESIM_SMS_NOT_SUPPORTED`); do not retry it. A message that was not sent gives 502 / 10008. An ICCID that is not one of your eSIMs gives 404 / 10004.