Get Package

View as Markdown

Get a plan by its package slug (from GET /esim/destination/{destinationSlug}), not by destination name.

Authentication

x-api-keystring

API key generated from the dashboard (Settings → API Keys). Each key is limited to 8 requests per 1-second window.

Path parameters

slugstringRequired

Plan slug from GET /esim/destination/{destinationSlug}, not a destination name

Query parameters

topUpbooleanOptional

Response

Successful response
packageCodestring
slugstring
namestring
pricedouble
currencyCodestring
volumedouble
smsStatusdouble
dataTypedouble
unusedValidTimedouble
durationdouble
durationUnitstring
locationstring
descriptionstring
activeTypedouble
speedstring
locationNetworkListlist of objects
ipExportstring
supportTopUpTypedouble
fupPolicystringOptional
subLocationListlist of objects or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error