Airalo Developer Platform
  1. Top-up flow
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Partner with Airalo
    • Attribute descriptions
    • FAQ
    • User journeys
      • Purchase journey
      • Top-up journey
    • Guides
      • How to set up a brand for eSIMs Cloud link sharing
      • How to get the eSIMs Cloud sharing link through API
      • How to generate the QR code for an eSIM
      • How to share eSIM installation instructions with users
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Product updates
    • Rate limits
    • Error handling
    • Guides
      • Step #1 - Authentication
    • Quick start
      • Request access token
      • Get packages
      • Submit order
      • Get installation instructions
    • Endpoints
      • Orders List
        • Get order list
        • Get order
      • Top-up flow
        • Get eSIMs list
          GET
        • Get top-up package list
          GET
        • Get eSIM package history
          GET
      • Notification
        • Understanding Webhooks: Asynchronous Communication for Modern Applications
        • Airalo Webhooks Optin and Flow
        • Async orders
        • Low data notification - opt In
        • Low data notification - opt out
        • Get low data notification
        • Credit limit notification
        • Webhook definition
        • Webhook simulator
      • Balance
        • Get balance
      • Request access token
        POST
      • Get compatible device list
        GET
      • Get packages
        GET
      • Submit order
        POST
      • Submit order async
        POST
      • Submit top-up order
        POST
      • Get eSIM
        GET
      • Get data usage
        GET
      • Get installation instructions
        GET
      • Update eSIM brand
        PUT
      • eSIM voucher
        POST
      • Refund Request
        POST
      • Future Orders
        POST
      • Cancel future orders
        POST
    • Deprecated
      • Authentication
        • Request Access Token
      • Orders
        • Get Order List
        • Get Order
        • Submit Order
        • Submit Top-up Order
      • eSIMs
        • Get eSIMs List
        • Get eSIM
        • Get Installation instructions
        • Get Data Usage
        • Get Top-up Package List
        • Get eSIM Package History
      • Order Statuses
        • Get Order Statuses List
        • Get Order Status Name
      • Packages
        • Get Packages
      • Compatible Devices
        • Get Compatible Device List
      • Notification
        • Low Data Notification
        • Credit Limit Notification
        • Webhook Definition
        • Webhook Simulator
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Product updates
    • Guides
      • How to install the plugin
      • How to setup the Shop price?
      • Customizing "My eSIM" page colors in WooCommerce
      • How to convert prices into local currency
      • How to finalize the shop setup
      • How to test in sandbox
      • How to go live
      • TO DELETE Installation plugin backup
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
      • Troubleshooting
  • SHOPIFY INTEGRATION
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Top-up flow

Get top-up package list

GET
/v2/sims/{iccid}/topups
Endpoint do support new type of packages - "Voice and Text"
To get the list of available packages for an eSIM:
Make a GET request to the endpoint URL https://partners-api.airalo.com/v1/sims/:iccid/topups, replace :iccid with the ICCID of the eSIM for which you want to purchase a top-up.
The API will respond with a JSON object containing an array of available top-up packages, each of which includes an ID, price, data amount, duration, and other information.
For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/sims/8910300000005271146/topups' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'
Response Response Example
200 - eSIM: List available top-up packages: 200 OK
{
  "data": [
    {
      "id": "bonbon-mobile-30days-3gb-topup",
      "type": "topup",
      "price": 10,
      "amount": 3072,
      "day": 30,
      "is_unlimited": false,
      "title": "3 GB - 100 SMS - 100 Mins - 30 Days",
      "data": "3 GB",
      "short_info": "This eSIM doesn't come with a phone number.",
      "voice": 100,
      "text": 100
    },
    {
      "id": "bonbon-mobile-30days-5gb-topup",
      "type": "topup",
      "price": 15,
      "amount": 5120,
      "day": 30,
      "is_unlimited": false,
      "title": "5 GB - 30 Days",
      "data": "5 GB",
      "short_info": "This eSIM doesn't come with a phone number.",
      "voice": 100,
      "text": 100
    },
    {
      "id": "bonbon-mobile-30days-10gb-topup",
      "type": "topup",
      "price": 22.5,
      "amount": 10240,
      "day": 30,
      "is_unlimited": false,
      "title": "10 GB - 30 Days",
      "data": "10 GB",
      "short_info": "This eSIM doesn't come with a phone number.",
      "voice": 100,
      "text": 100
    }
  ]
}

Request

Path Params
iccid
string 
required
eSIM ICCID, used to query a list of available top-up packages.
Required. Can be obtained by execuring GET to the "eSIMs List" endpoint
Example:
8910300000005271146
Header Params
Accept
string 
required
Example:
application/json
Authorization
string 
required
Example:
Bearer {{token}}

Responses

🟢200eSIM: List available top-up packages: 200 OK
application/json
Body
data
array [object {11}] 
required
id
string 
required
type
string 
required
price
integer  | number 
required
amount
integer 
required
day
integer 
required
is_unlimited
boolean 
required
title
string 
required
data
string 
required
short_info
string 
required
voice
integer 
required
text
integer 
required
🟢200eSIM: List available top-up packages: 200 (No top-up packages available)
🟢200eSIM: List available top-up packages: 404 (Invalid ICCID)
🟠422eSIM: List available top-up packages: (Recycled Sim Response 422)
Modified at 2025-05-12 15:00:30
Previous
Get eSIMs list
Next
Get eSIM package history
Built with