eSIMply orders

Get eSIM data usage by ICCID

Overview

Retrieve live data usage for an eSIM: remaining allowance, total allowance, expiry, and status.

When to Use

  • Usage meters - Show travelers how much data remains
  • Top-up prompts - Trigger upsell when remaining data is low
  • Status checks - Confirm whether an eSIM is still active

What You Get

  • Remaining / total - Data volumes in MB
  • Expiry - When the current allowance expires
  • Status - Current eSIM usage status

Key Features

  • Live provider data: Usage is fetched from eSIMply for the given ICCID
  • Lightweight: No pricing or catalog payload—usage only
  • Pairs with top-ups: Use remaining data to decide when to offer top-ups
get/esimply/usage/{iccid}

Request

  • Base URL
    https://api.liteapi.travel/v3.0
  • URL
    https://api.liteapi.travel/v3.0/esimply/usage/{iccid}
  • Auth
    API key in header X-API-Key

Path parameters

iccidstring required
Example:89000000000000000001

Response

Data usage retrieved successfully

Example response

{
  "data": {
    "remaining": 1024,
    "total": 1024,
    "expiredAt": "2026-08-27T00:00:00Z",
    "status": "active"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.