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

Endpoints

Authenticate
Browse packages
Request refund
Place order
Install eSIM
Monitor usage
Top up eSIM
Manage orders
Manage eSIMs
Compatible devices
Notifications
Check balance
Product Information
Previous
Refund policy
Next
Authenticate
Built with