eSIMply orders

List top-ups for an eSIM

Overview

Retrieve top-up packages that can be applied to an existing eSIM identified by ICCID.

When to Use

  • Top-up UI - Show add-on data packs for a traveler's active eSIM
  • Upsell after purchase - Offer more data when usage is low
  • Eligibility check - Confirm which packages are valid for a given ICCID

What You Get

  • Top-up packages - Package IDs, sizes, validity, and prices
  • External package IDs - Required when submitting a top-up

Key Features

  • ICCID-scoped: Returns only packages eligible for that eSIM
  • Currency conversion: Optional Currency header for priced fields
  • Feeds POST /esimply/orders/submit-topup: Use returned IDs in the top-up submit request
get/esimply/orders/topups/{iccid}

Request

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

Path parameters

iccidstring required
Example:89000000000000000001

eSIM ICCID

Headers

Currencystring
Example:EUR

Optional ISO-4217 currency code. When set, priced fields are converted using liteAPI exchange rates only (not forwarded to eSIMply).

Response

Top-ups retrieved successfully

Example response

{
  "data": [
    {
      "packageId": 1,
      "name": "1 GB",
      "dataSizeMb": 1024,
      "validityDays": 7,
      "providerId": 3,
      "providerPackageId": 13354,
      "price": 0,
      "externalPackageId": "choukran-7days-1gb",
      "calculatedPrice": 7,
      "rn": 1
    }
  ]
}

Changes

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