Airalo Developer Platform
  1. REST API
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
      • How to share eSIM installation instructions with users
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Product updates
    • Rate limits
    • Error handling
    • Endpoints
      • Orders List
        • Get order list
        • Get order
      • Top-up flow
        • Get eSIMs list
        • Get top-up package list
        • Get eSIM package history
      • 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
      • Get packages
      • Get compatible device list
      • Future Orders
      • eSIM voucher
      • Get eSIM
      • Cancel future orders
      • Submit order
      • Refund Request
      • Get installation instructions
      • Submit order async
      • Get usage (data, text & voice)
      • Submit top-up order
      • Update eSIM brand
    • Guides
      • Step #1 - Authentication
    • 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 APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. REST API

Introduction

REST API overview#

The Airalo Partner API provides seamless access to Airalo’s eSIMs, allowing you to integrate core connectivity features directly into your application or system. Whether you’re managing eSIM orders, sharing eSIMs with users, or receiving real-time notifications when data is running low, this REST API gives you the tools to deliver a reliable and scalable connectivity solution tailored for travelers.
Use this API to enhance your product offering by enabling your users to discover, purchase, and manage travel eSIMs effortlessly.

Key features#

Flexible integration: Access a wide range of endpoints to manage orders, eSIMs, packages, and more.
Scalable design: Designed to support your business as it grows, ensuring consistent performance.

Future versions#

Airalo reserves the right to extend the Partner API responses and requests with new attributes. Partners must ensure their integration can handle these changes, as they are considered backward-compatible.

API modes#

To simplify integration and streamline workflows, the Airalo Partner API now operates in a single environment where you can switch between Sandbox and Production modes using a configuration setting. This unified approach eliminates the need for separate base URLs or different API credentials, and ensures a smoother transition from testing to live using the same production eSIM packages across both modes.
EnvironmentDescription
SandboxA simulation mode used for development and testing. API requests in this mode do not affect live data or trigger real provisioning, while still using the production eSIM packages. Ideal for validating your integration before going live.
ProductionA Production mode used for real transactions and provisioning. Switch to this mode once your application is fully tested and ready for deployment.
Modified at 2025-07-01 13:49:00
Previous
eSIM installation methods for API Partners
Next
Product updates
Built with