Skip to main content
GET
Get eSIM
Required scope: PARTNER
Returns the status of an eSIM you ordered, its tier and its mobile data use this month. The partner.esim.ready and partner.esim.failed webhooks tell you when the status changes. Without a webhook endpoint, poll this endpoint instead, within the rate limit of 20 read requests per second per key. failure_code is null unless status is FAILED. You can only read eSIMs ordered on accounts your own API key created. Any other id fails with PARTNER_ESIM_NOT_FOUND.

Tier

  • tier is the eSIM’s current tier. It changes when an upgrade from Change eSIM tier is paid, or when a scheduled downgrade applies. Until then, it is the tier you ordered.
  • scheduled_tier is the tier a scheduled downgrade will switch the eSIM to, and scheduled_tier_at is when, at the end of the period already paid. Both are null when no downgrade is scheduled.

Data use

data gives the eSIM’s mobile data use for the current month. It is null unless status is ACTIVE.
  • The cycle is the calendar month in Paris time. The timestamps are in UTC, so in November 2026 the cycle runs from 2026-10-31T23:00:00 to 2026-11-30T23:00:00.
  • Allo reads the use live from the network on each call. It can lag real use by a few minutes.
  • When the eSIM reaches its allowance, mobile data stops until the next month or until you buy a top-up. Calls and SMS keep working. The line is never billed for data beyond the allowance.
  • Allo sends partner.esim.data_low when the eSIM has used 80% of its allowance, and partner.esim.data_exhausted when it has used all of it. You do not need to poll this endpoint to watch the data.

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

The eSIM id returned by Order eSIM (eso-*).

Response

eSIM

data
object