Skip to main content
GET
My eSIMs
Lists the eSIMs on your account (latest 50) with activation details and live data usage.

Status fields

  • status — success, processing or failed.
  • esim_status — the provider lifecycle, e.g. GOT_RESOURCE (ready to install), IN_USE, USED_UP, EXPIRED.
  • data_total_gb / data_used_gb / data_remaining_gb — usage in GB (may be null until the provider reports it).
  • expired_at / purchased_at — ISO 8601 timestamps.
Pass refresh=true to pull fresh status and usage from the provider for your active eSIMs (up to 10 per call). Without it, the stored values are returned instantly.

Authorizations

Authorization
string
header
required

Send your API key as Token <your_api_key>.

Use your live key for real transactions, or your sandbox key (sk_test_…) to test — sandbox calls return a realistic simulated result and never touch your wallet. Add "sandbox_status": "fail" to any sandbox request to simulate a failure.

Query Parameters

refresh
boolean

Set true to re-sync live status/usage from the provider

Response

200 - application/json

Success

status
string
data
object[]