---
updatedAt: 2026-08-12T15:10:29.000Z
agentTools:
  projectIndex: https://docs.liteapi.travel/llms.txt
---

# 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

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "API: eSIMply",
    "version": "3.1.0",
    "description": "The eSIMply API lets partners browse destinations, regional/global groups and data packages, provision eSIMs in real time, top up existing eSIMs, and monitor usage. Access is gated by `users.esimply_access`. Use a `sand_*` API key for the eSIMply sandbox environment and a `prod_*` key for production."
  },
  "servers": [
    {
      "url": "https://api.liteapi.travel/v3.0"
    }
  ],
  "security": [
    {
      "apikeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "eSIMply orders",
      "description": "Cart, purchase, top-up, order history, and usage"
    }
  ],
  "components": {
    "securitySchemes": {
      "apikeyAuth": {
        "name": "X-API-Key",
        "type": "apiKey",
        "in": "header"
      }
    },
    "parameters": {
      "CurrencyHeader": {
        "name": "Currency",
        "in": "header",
        "required": false,
        "schema": {
          "type": "string",
          "example": "EUR"
        },
        "description": "Optional ISO-4217 currency code. When set, priced fields are converted using liteAPI exchange rates only (not forwarded to eSIMply)."
      }
    },
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "integer",
                "description": "liteAPI error code",
                "example": 61001
              },
              "message": {
                "type": "string",
                "example": "validation error"
              },
              "description": {
                "type": "string",
                "example": "lang must be en or fr"
              }
            }
          }
        },
        "example": {
          "error": {
            "code": 61001,
            "message": "validation error",
            "description": "lang must be en or fr"
          }
        }
      },
      "TopUpPackage": {
        "type": "object",
        "properties": {
          "packageId": {
            "type": "integer",
            "example": 1
          },
          "name": {
            "type": "string",
            "example": "1 GB"
          },
          "dataSizeMb": {
            "type": "integer",
            "example": 1024
          },
          "validityDays": {
            "type": "integer",
            "example": 7
          },
          "providerId": {
            "type": "integer",
            "example": 3
          },
          "providerPackageId": {
            "type": "integer",
            "example": 13354
          },
          "price": {
            "type": "number",
            "example": 0
          },
          "externalPackageId": {
            "type": "string",
            "example": "choukran-7days-1gb"
          },
          "calculatedPrice": {
            "type": "integer",
            "example": 7
          },
          "rn": {
            "type": "integer",
            "example": 1
          }
        },
        "example": {
          "packageId": 1,
          "name": "1 GB",
          "dataSizeMb": 1024,
          "validityDays": 7,
          "providerId": 3,
          "providerPackageId": 13354,
          "price": 0,
          "externalPackageId": "choukran-7days-1gb",
          "calculatedPrice": 7,
          "rn": 1
        }
      }
    }
  },
  "paths": {
    "/esimply/orders/topups/{iccid}": {
      "get": {
        "tags": [
          "eSIMply orders"
        ],
        "summary": "List top-ups for an eSIM",
        "operationId": "getESimplyTopUps",
        "description": "## Overview\n\nRetrieve top-up packages that can be applied to an existing eSIM identified by ICCID.\n\n## When to Use\n\n- **Top-up UI** - Show add-on data packs for a traveler's active eSIM\n- **Upsell after purchase** - Offer more data when usage is low\n- **Eligibility check** - Confirm which packages are valid for a given ICCID\n\n## What You Get\n\n- **Top-up packages** - Package IDs, sizes, validity, and prices\n- **External package IDs** - Required when submitting a top-up\n\n## Key Features\n\n- **ICCID-scoped**: Returns only packages eligible for that eSIM\n- **Currency conversion**: Optional `Currency` header for priced fields\n- **Feeds POST /esimply/orders/submit-topup**: Use returned IDs in the top-up submit request",
        "parameters": [
          {
            "name": "iccid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "example": "89000000000000000001"
            },
            "description": "eSIM ICCID",
            "example": "89000000000000000001"
          },
          {
            "$ref": "#/components/parameters/CurrencyHeader"
          }
        ],
        "responses": {
          "200": {
            "description": "Top-ups retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "data"
                  ],
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/TopUpPackage"
                      }
                    }
                  }
                },
                "example": {
                  "data": [
                    {
                      "packageId": 1,
                      "name": "1 GB",
                      "dataSizeMb": 1024,
                      "validityDays": 7,
                      "providerId": 3,
                      "providerPackageId": 13354,
                      "price": 0,
                      "externalPackageId": "choukran-7days-1gb",
                      "calculatedPrice": 7,
                      "rn": 1
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Invalid ICCID or currency",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "error": {
                    "code": 64001,
                    "message": "validation error",
                    "description": "ICCID is required"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authentication required",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "error": {
                    "code": 401,
                    "message": "unauthorized"
                  }
                }
              }
            }
          },
          "403": {
            "description": "eSIMply access not enabled for this account",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "accessNotEnabled": {
                    "summary": "Account without eSIMply access",
                    "value": {
                      "error": {
                        "code": 40301,
                        "message": "user does not have enough permissions to perform this action",
                        "description": "eSIMply API access is not enabled for this account. Please contact support to get access"
                      }
                    }
                  },
                  "sandboxOnlyWithProdKey": {
                    "summary": "Sandbox-only account using a production API key",
                    "value": {
                      "error": {
                        "code": 40301,
                        "message": "user does not have enough permissions to perform this action",
                        "description": "eSIMply API for this account is limited to sandbox API keys only. Please contact support to get full access"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Order not found for ICCID",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "error": {
                    "code": 64003,
                    "message": "order not found",
                    "description": "order not found"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```