Skip to main content

Overview

After a user selects a region, fetch available eSIM packages with their pricing, data allowance, and validity period. Packages come in two types: BASE (new eSIM) and TOPUP (add data to existing eSIM).

Quick Start

Response Format

The API returns a direct array of package objects:
Important: The response is a direct array, not wrapped in an object with a packages key.

Response Fields

Location Network Object

Data Volume Conversion: The volume field is in bytes. Convert to GB: volume / 1073741824

Understanding Location Networks

Each package includes detailed information about supported locations and mobile operators:

Query Parameters

Required Parameters

  • regionCode (required): The region code to fetch packages for (e.g., “US”, “EU-42”)

Optional Parameters

  • type: Package type filter
    • BASE: New eSIM packages (default)
    • TOPUP: Top-up packages for existing eSIMs
  • regionType: Filter by region type
    • LC: Local (single country)
    • RG: Regional (multi-country)
    • GL: Global
  • packageCode: Specific package code (required when type=TOPUP)

Filter by Package Type

Top-Up Packages: When fetching top-up packages, you must provide the packageCode of the BASE package the user originally purchased. Top-up packages are filtered to only show compatible data add-ons for that eSIM.

Filter by Region Type

Next Steps

Purchase eSIM

Complete the purchase with selected package

Get Top-Up Packages

Add data to existing eSIM