Skip to main content

Overview

Top up an existing eSIM with additional data using top-up packages. This extends the data allowance of an active eSIM without creating a new one.
Key Requirements: Top-ups require:
  • packageType: 'TOPUP'
  • packageCode: TOPUP package code (e.g., “TOPUP_P3ICIKSE8”)
  • esimId: The ID of the eSIM to top up (obtained from previous purchase or fetch)
Two-Step Process: Like purchases, the top-up API returns a transactionId. Query /api/esim/{transactionId} to get updated eSIM details with the new data balance.

Quick Start

Request Body

Finding TOPUP Packages: Query /api/esim/packages?regionCode=US&type=TOPUP&packageCode=CKH533 to get available top-up packages. Top-up package codes are prefixed with TOPUP_.

Successful Response

Step 1: Purchase Response
Step 2: Updated eSIM Details
The totalVolume and data_usage_remain are updated to reflect the added data. Values are in bytes.

Next Steps

Purchase eSIM

Buy a new eSIM package

API Reference

Complete API documentation