Skip to main content
GET
Get eSIM status
Installation, activation and refund eligibility for one eSIM, read live from the network on every call.
The data_* fields cover today only. Every plan resets daily, and data_total_mb is the daily allowance. For usage across the whole plan, use Get eSIM usage.

Statuses

refundable is true only while the eSIM is not installed, not refunded, and inside its activation window. When it is false, non_refundable_reason says which of those failed. Check it before you request a refund.

Authorizations

X-Esimmu-Access-Key
string
header
required

Your partner access key. Identifies you on every request.

X-Esimmu-Signature
string
header
required

Lowercase hex HMAC-SHA256 over the five-line string {METHOD}\n{REQUEST_PATH}\n{TIMESTAMP}\n{ACCESS_KEY}\n{BODY_SHA256}, keyed with your Base64-decoded secret key.

REQUEST_PATH includes the /api prefix and excludes the domain and any query string. BODY_SHA256 is the lowercase hex SHA-256 of the exact body bytes you send; for a request with no body, hash the empty string. The string always has five lines.

X-Esimmu-Timestamp
string
header
required

Unix seconds (UTC), within 5 minutes of our clock.

Path Parameters

topup_id
string
required

The eSIM, as returned by Create an order and sent in esim.issued.

Response

The eSIM's current state.

created_at
string<date-time> | null
installed_at
string<date-time> | null
activated_at
string<date-time> | null
expires_at
string<date-time> | null

When the plan ends, once activated.

device_name
string | null
install_count
integer | null
eid
string | null
data_total_mb
number

Today's allowance. Plans reset daily.

data_used_mb
number

Used today.

data_remaining_mb
number

Left today.

refundable
boolean

Whether a refund request can still succeed: not installed, not refunded, activation window open.

non_refundable_reason
enum<string> | null
Available options:
refunded,
esim_installed,
activation_expired,
null
status
enum<string>
Available options:
not_installed,
installed,
activated,
expired,
activation_expired,
refunded
activation_expiration_at
string<date> | null

Last day to install and activate. After it the eSIM can no longer be used.

Last modified on November 16, 2026