Airalo Developer Platform
  1. Quick start
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Quick start
      • Step 1: Request access token
        POST
      • Step 2: Get packages
        GET
      • Step 3: Submit order
        POST
      • Step 4: Get installation instructions
        GET
    • 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
        • Get compatible device list
      • 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
        • Get top-up package list
        • Get eSIMs list
        • Get eSIM package history
      • Manage orders & eSIMs
        • Get order list
        • Cancel future orders
        • Get order
        • Update eSIM brand
      • 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
  1. Quick start

Step 2: Get packages

GET
/v2/packages
💡
Action Required: Synchronize at least once every hour.
This step is vital for ensuring newly introduced packages are available and out-of-stock packages are excluded.
This endpoint allows you to retrieve a list of local and global packages from the Airalo Partners API. Local packages include eSIMs for a single country, while global packages cover multiple countries and regions. You can filter the results by operator type or country code and adjust pagination settings.

Rate Limit#

This endpoint allows up to 40 requests per minute. Ensure your implementation respects this limit to avoid rate limit errors.

Important Notes#

Include the access token, obtained from the Request Access Token endpoint, in the request headers for authentication.
This endpoint does support the new type of packages - "Voice and Text"
For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ

Request

Query 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 -g --request GET '/v2/packages?filter[type]=global&filter[country]=TR&limit=&page=1&include=topup' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

Responses

🟢200List Packages (200)
application/json
Body

Example
{
    "data": [
        {
            "slug": "united-states",
            "country_code": "US",
            "title": "United States",
            "image": {
                "width": 132,
                "height": 99,
                "url": "https://cdn.airalo.com/images/600de234-ec12-4e1f-b793-c70860e4545a.png"
            },
            "operators": [
                {
                    "id": 687,
                    "style": "light",
                    "gradient_start": "#0f1b3f",
                    "gradient_end": "#194281",
                    "type": "local",
                    "is_prepaid": false,
                    "title": "Change",
                    "esim_type": "Prepaid",
                    "warning": null,
                    "apn_type": "manual",
                    "apn_value": "wbdata",
                    "is_roaming": true,
                    "info": [
                        "5G Data-only eSIM.",
                        "Rechargeable online with no expiry.",
                        "Operates on T-Mobile and Verizon networks in the United States of America."
                    ],
                    "image": {
                        "width": 1035,
                        "height": 653,
                        "url": "https://cdn.airalo.com/images/030f0576-f611-4eee-bba5-eb90a994c4ff.png"
                    },
                    "plan_type": "data",
                    "activation_policy": "first-usage",
                    "is_kyc_verify": false,
                    "rechargeability": true,
                    "other_info": "This eSIM is for travelers to the United States. The coverage applies to all 50 states of the United States, and Puerto Rico.",
                    "coverages": [
                        {
                            "name": "US",
                            "code": "US",
                            "networks": [
                                {
                                    "name": "T-Mobile",
                                    "types": [
                                        "5G"
                                    ]
                                },
                                {
                                    "name": "Verizon",
                                    "types": [
                                        "5G"
                                    ]
                                }
                            ]
                        }
                    ],
                    "install_window_days": null,
                    "topup_grace_window_days": null,
                    "apn": {
                        "ios": {
                            "apn_type": "automatic",
                            "apn_value": "wbdata"
                        },
                        "android": {
                            "apn_type": "manual",
                            "apn_value": "wbdata"
                        }
                    },
                    "packages": [
                        {
                            "id": "change-7days-1gb",
                            "type": "sim",
                            "price": 4.5,
                            "amount": 1024,
                            "day": 7,
                            "is_unlimited": false,
                            "title": "1 GB - 7 Days",
                            "short_info": "This eSIM doesn't come with a phone number.",
                            "qr_installation": "<p><b>eSIM name:</b> Change</p><p><b>Coverage: </b>United States</p><p><b>To activate the eSIM by scanning the QR code on your eSIM capable device you need to print or display this QR code on other device:</b></p><ol><li>Settings > Cellular/Mobile > Add Cellular/Mobile Plan.</li><li>Scan QR code.</li><li>Confirm eSIM plan details.</li><li>Label the eSIM.</li></ol><p><b>To access Data:</b></p><ol><li>Enable data roaming.</li></ol><p><b>To top up:</b></p><p>Visit airalo.com/my-esims or if purchased through the Airalo website/app visit “My eSIMs” tab.</p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p>",
                            "manual_installation": "<p><b>eSIM name:</b> Change</p><p><b>Coverage: </b>United States</p><p><b>To manually activate the eSIM on your eSIM capable device:</b></p><ol><li>Settings > Cellular/Mobile > Add Cellular/Mobile Plan.</li><li>Manually enter the SM-DP+ Address and activation code.</li><li>Confirm eSIM plan details.</li><li>Label the eSIM.</li></ol><p><b>To access Data:</b></p><ol><li>Enable data roaming.</li></ol><p><b>To top up:</b></p><p>Visit airalo.com/my-esims or if purchased through the Airalo website/app visit “My eSIMs” tab.</p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p>",
                            "is_fair_usage_policy": false,
                            "fair_usage_policy": null,
                            "data": "1 GB",
                            "voice": null,
                
🟢200List Packages with topup (200)
🟢200List Global Packages (200)
🟢200List Local Packages (200)
🟢200List Local Packages for Specific Country (200)
🟢200List Packages with Pagination (200)
🟢200List Packages with Pagination page>=2 (200)
🟠422List Packages (422)
Modified at 2025-06-19 10:57:55
Previous
Step 1: Request access token
Next
Step 3: Submit order
Built with