1. OVERVIEW
Airalo Developer Platform
  • 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
    • Rate limits
    • Error handling
    • Go live checklist
    • Endpoints
      • Authenticate
        • Request access token
      • Browse packages
        • Get packages
      • Place order
        • Future orders
        • Submit order
        • Submit order async
        • eSIM voucher
      • Request refund
        • Request refund
      • Install eSIM
        • Get eSIM
        • Get installation instructions
      • Monitor usage
        • Get usage (data, text & voice)
      • Place top up order
        • 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
      • 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
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Guides
      • How to install the Airalo Plugin for WooCommerce
      • How to customize the "My eSIMs" page colors in WooCommerce
      • How to convert prices into your local currency
  1. OVERVIEW

FAQ

Integration and setup#

What is the difference between the SDK and the REST API?
The SDK offers pre-built tools and libraries to simplify and accelerate your integration, whereas the REST API provides direct access to our endpoints for those who require a fully customized or more flexible implementation.
Are packages and prices the same in Sandbox and Production?
Should I migrate from V1 to V2 of the Airalo API?
How do I configure Single Sign-On (SSO)?
What are the supported languages in Production and Sandbox modes?
Can I install and activate eSIMs purchased in Sandbox mode?
How do I provision my employee directory through SSO SCIM?

Catalog and package management#

How can I access regional or global packages?
Can I retrieve a specific package by package_id or filter by country?
Can I store eSIM packages?
How can I avoid `out of stock` packages?
Why can’t I purchase certain eSIMs on the Partner platform?
Where do I find a list of supported country codes?

Orders and top-ups#

Is there an order cancelation API available via an endpoint?
Do you store my end-user's data?
How can I send additional parameters in Submit Order / Submit Top-up Order API methods?
How do packages with calls and texts work?
How do I make a bulk purchase via the Partner API?
Can I send a request for 2 or more people in 1 order?
How do I purchase a top-up package?
Do you support refund requests via the Airalo Partner API?

Pricing and billing#

Are promotional prices on Airalo’s B2C products (airalo.com) applied to API Partners?
How often are package prices updated?
What is the minimum selling price?
Where can I find the retail and net prices in the responses?

Device and network behavior#

What are the different statuses of eSIM packages?
Where can I find information for the manual and QR code installation methods on iOS and Android devices?
How is the activation policy provided for eSIM packages in the Partner API?
Where can I find the SM-DP+ Address and activation code?
What do airalo_code and confirmation_code refer to in the Get eSIM endpoint?
Do users need to activate an eSIM within a specific time period?
What Service Network Provider (SPN) will show up when users install an eSIM purchased through the Partner API?
How can I generate a QR code?
How can I determine if status and usage information is available for an eSIM package?
How can I use universal links to support direct installation on iOS?
Can eSIMs be reinstalled?
Can your eSIMs switch between multiple operators automatically?
Why does the API return multiple sets of instructions for iOS and Android?
Do my users need to set up an APN to install the eSIM?

Branding and platform extensions#

How do I get the eSIMs Cloud sharing link through API?
Can I change the eSIM package name?
Do you support integration with WooCommerce?
How do I set up prices in WooCommerce?
How do I set up a brand in the Partner platform?
Can I customize the Service Provider Network (SPN) for my users?
Can I build a complete white label experience using the Airalo Partner API?
How do I install and configure the Airalo WooCommerce plugin?

Troubleshooting and support#

What types of errors can occur during eSIM activation?
What steps should I take when an order fails?
Can I register for WhatsApp with the Discover+ package?
Modified at 2026-04-01 15:48:17
Previous
Attribute descriptions
Next
Developer feedback
Built with