1. REST API
Airalo Partner API
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Developer feedback
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: Get installation instructions
    • 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
    • Go live checklist
    • Sandbox mode
    • Upgrade from v1 to v2 guide
    • Error handling
    • Rate limits
    • IP allowlist / whitelisting
    • Refund policy
    • Endpoints
      • Authenticate
        • Request access token
      • Browse packages
        • Get packages
      • Request refund
        • Request refund
      • Place order
        • Future orders
        • Submit order
        • Submit order async
        • eSIM voucher
      • Install eSIM
        • Get eSIM
        • Get installation instructions
      • Monitor usage
        • Get usage (data, text & voice)
      • Top up eSIM
        • Get top-up package list
        • Submit top-up order
      • Manage orders
        • Get order list
        • Get order
        • Cancel future orders
        • Future Orders
      • Manage eSIMs
        • Update eSIM brand
        • Get eSIMs list
        • Get eSIM package history
      • Compatible devices
        • [Deprecated] Get compatible device list
        • Get compatible device lite list
        • Check device compatibility
      • Notifications
        • Airalo webhooks opt-in and flow
        • Webhooks guide
        • Webhook definition
        • Notification: Low data
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Credit limit
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Async orders
          • Opt in
          • Get notification details
          • Opt out
        • Webhook simulator
      • Check balance
        • Get balance
      • Product Information
        • Get Product Information (PIB)
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • Whitelabel eSIM platform
    • Whitelabel eSIM platform integration guide
  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.

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.
❗
Version 1 of the Partner API is being retired in 2027.
1st January 2027: Migration support begins. Your account manager can help you plan and test the move.
1st March 2027: v1 requests are still accepted, but they are processed by v2 and return v2 responses. If your integration has not been updated by then, it starts receiving the v2 response format from this date.
1st May 2027: v1 is switched off, and requests to v1 endpoints are rejected.
Follow the Upgrade from V1 to V2 guide to prepare your integration.
For many integrations the move is as simple as a URL change.

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.
ModeDescription
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 2026-10-26 16:28:19
Previous
eSIM installation methods for API Partners
Next
Go live checklist
Built with