Airalo Developer Platform
  1. Place top up order
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: Get installation instructions
    • 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
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Rate limits
    • Error handling
    • Endpoints
      • Authenticate
        • Request access token
      • Browse packages
        • Get packages
      • Place order
        • Submit order
        • Submit order async
        • Future orders
        • eSIM voucher
      • Install eSIM
        • Get eSIM
        • Get installation instructions
      • Monitor usage
        • Get usage (data, text & voice)
      • Place top up order
        • Submit top-up order
          POST
        • Get top-up package list
          GET
        • Get eSIMs list
          GET
        • Get eSIM package history
          GET
      • Manage orders & eSIMs
        • Get order list
        • Cancel future orders
        • Get order
        • Update eSIM brand
      • Compatible devices
        • [Deprecated] Get compatible device list
        • Get compatible device lite list
      • Notifications
        • Airalo webhooks optin and flow
        • Understanding webhooks: Asynchronous communication for modern applications
        • Async orders
        • Low data notification - opt In
        • Low data notification - opt out
        • Get low data notification
        • Credit limit notification
        • Webhook definition
        • Webhook simulator
      • Check balance
        • Get balance
      • Refunds
        • Refund request
    • Guides
      • Step #1 - Authentication
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • 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
      • Customizing WooCommerce email templates for eSIM sales
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Place top up order

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

Path Params

Header Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/sims/8910300000005271146/topups' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

Responses

🟢200eSIM: List available top-up packages: 200 OK
application/json
Body

Example
{
    "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
        }
    ]
}
🟢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-07-10 09:55:54
Previous
Submit top-up order
Next
Get eSIMs list
Built with