Skip to main content
GET
Get Top-Up Packages

Endpoint

Description

Returns available top-up (data refill) packages for an existing eSIM. Top-up packages let you add more data to an active eSIM without creating a new one. You need to provide the region code and the original package code of the eSIM you want to top up.

Authentication

string
required
API Key for authentication

Query Parameters

string
required
Must be TOPUP to fetch top-up packages.
string
required
Region code of the existing eSIM (e.g., US, GB, EU).
string
required
The original package code of the eSIM to top up (e.g., CKH384).You can get this from the eSIM order details (GET /api/esim/my-esims or GET /api/esim/:id).

Response

Returns an array of top-up packages with pricing.
string
Top-up package identifier. Use this code when purchasing the top-up.
string
Top-up package display name
number
Price in USD (with markup applied)
string
Currency code (always USD)
number
Additional data volume in bytes. Divide by 1073741824 to get GB.
number
Additional validity period (number of units)
string
Duration unit — DAY, HOUR, or MONTH
string
Network speed (e.g., 3G/4G/5G)

Example Request

Example Response

Not all eSIM packages support top-ups. If no top-up packages are returned, the eSIM does not support data refills.

Next Steps

Top-Up eSIM

Apply a top-up to your eSIM

My eSIMs

Get your existing eSIMs

Exchange Rate

Get USD → NGN rate

Integration Guide

Full top-up integration guide