List plans for a destination
curl --request GET \
--url https://sandbox-api.sakawave.example/v1/esims/catalog/regions/{code}/packages \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox-api.sakawave.example/v1/esims/catalog/regions/{code}/packages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sandbox-api.sakawave.example/v1/esims/catalog/regions/{code}/packages"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"slug": "united-states-5gb-30d-pkgus5gb",
"name": "United States 5GB",
"description": null,
"region": {
"code": "US",
"name": "United States",
"kind": "country",
"flagEmoji": "🇺🇸"
},
"dataType": "fixed",
"data": {
"totalBytes": "5368709120",
"dailyCapBytes": null,
"display": "5 GB"
},
"validityDays": 30,
"price": {
"amount": "999",
"currency": "USD",
"display": "9.99"
},
"supportsTopUp": true,
"supportsPlatformSms": false,
"coverage": [
"US"
]
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 1,
"totalPages": 1
}
}{
"statusCode": 400,
"message": "Must be a valid identifier.",
"code": "validation_failed",
"errors": [
{
"message": "Must be a valid identifier.",
"field": "accountId",
"code": "custom",
"path": [
"accountId"
]
}
]
}{
"statusCode": 401,
"code": "INVALID_API_KEY",
"message": "Invalid or inactive API credentials."
}{
"statusCode": 404,
"code": "resource_not_found",
"message": "Resource not found."
}{
"statusCode": 429,
"message": "Too many API requests. Try again later.",
"code": "api_key_rate_limit_exceeded",
"retryAfterSeconds": 17
}{
"statusCode": 500,
"code": "internal_server_error",
"message": "An unexpected error occurred."
}{
"statusCode": 503,
"code": "provider_unavailable",
"message": "We could not issue an account number just now. Try again shortly."
}eSIM
List plans for a destination
The data plans available for one destination, cheapest first.
GET
/
v1
/
esims
/
catalog
/
regions
/
{code}
/
packages
List plans for a destination
curl --request GET \
--url https://sandbox-api.sakawave.example/v1/esims/catalog/regions/{code}/packages \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox-api.sakawave.example/v1/esims/catalog/regions/{code}/packages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sandbox-api.sakawave.example/v1/esims/catalog/regions/{code}/packages"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"slug": "united-states-5gb-30d-pkgus5gb",
"name": "United States 5GB",
"description": null,
"region": {
"code": "US",
"name": "United States",
"kind": "country",
"flagEmoji": "🇺🇸"
},
"dataType": "fixed",
"data": {
"totalBytes": "5368709120",
"dailyCapBytes": null,
"display": "5 GB"
},
"validityDays": 30,
"price": {
"amount": "999",
"currency": "USD",
"display": "9.99"
},
"supportsTopUp": true,
"supportsPlatformSms": false,
"coverage": [
"US"
]
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 1,
"totalPages": 1
}
}{
"statusCode": 400,
"message": "Must be a valid identifier.",
"code": "validation_failed",
"errors": [
{
"message": "Must be a valid identifier.",
"field": "accountId",
"code": "custom",
"path": [
"accountId"
]
}
]
}{
"statusCode": 401,
"code": "INVALID_API_KEY",
"message": "Invalid or inactive API credentials."
}{
"statusCode": 404,
"code": "resource_not_found",
"message": "Resource not found."
}{
"statusCode": 429,
"message": "Too many API requests. Try again later.",
"code": "api_key_rate_limit_exceeded",
"retryAfterSeconds": 17
}{
"statusCode": 500,
"code": "internal_server_error",
"message": "An unexpected error occurred."
}{
"statusCode": 503,
"code": "provider_unavailable",
"message": "We could not issue an account number just now. Try again shortly."
}Prices are USD, which is what the catalog is denominated in. What a particular account pays is decided by a quote.
supportsTopUp decides whether this plan can extend an eSIM already installed, rather than only being sold as a new one.
Error codes
| Status | code | Cause |
|---|---|---|
404 | esim_region_not_found | No such destination. |
401 | INVALID_API_KEY | The key is missing, invalid, inactive, expired, from the other environment, or blocked by its IP allowlist. |
429 | api_key_rate_limit_exceeded | The per-minute limit for this key was exceeded. |
503 | esim_feature_disabled | eSIM is not enabled on this deployment. |
503 | esim_catalog_unavailable | The catalog is empty and could not be refreshed from the provider. |
503 | esim_provider_unavailable | The eSIM provider could not be reached. Nothing was charged. |
Authorizations
A secret API key, sent as Authorization: Bearer sk_test_… in sandbox or Bearer sk_live_… in live.
Path Parameters
Destination code from the destinations list.
Query Parameters
One-based page number.
Required range:
x >= 1Records per page.
Required range:
1 <= x <= 100