Skip to main content
GET
Get eSIM usage
Data used over the whole plan, day by day. Unlike Get eSIM status, it still answers after the plan has expired.
  • history holds the finished days, newest first. Today is not in it.
  • today_usage_mb is today so far.
  • total_usage_mb is the two together.

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

Usage over the plan.

iccid
string | null
today_usage_mb
number
total_usage_mb
number
history
object[]

Finished days, newest first. Today is not included.

Last modified on November 16, 2026