Endpoints
Copy Page
Airalo Partner API documentation
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
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
Go live checklist
Sandbox mode
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
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)
Guides
Step #1 - Authentication
SDKs
Introduction
SDK vs. REST API
Technical notes
WOOCOMMERCE PLUGIN
Introduction
Product updates
Guides
How to install the Airalo Plugin for WooCommerce
How to set up prices in WooCommerce
How to customize the "My eSIMs" page colors in WooCommerce
How to convert prices into your local currency
How to finalize your WooCommerce shop setup
How to test in sandbox mode
How to go live
How to customize WooCommerce email templates for eSIM sales
Troubleshooting
Troubleshooting
SHOPIFY APP
Introduction
Guides
How to set up prices in Shopify
How to install the Airalo Shopify App
Whitelabel eSIM platform
Whitelabel eSIM platform integration guide
Endpoints
Copy Page
Monitor usage
Get usage (data, text & voice)
GET
/v2/sims/{sim_iccid}/usage
:::highlight blue 💡This endpoint comes with a rate limit: 10 requests per minute (per unique iccid) 5 requests per second (per unique company) A ...
Previous
Get installation instructions
Next
Get usage (data, text & voice)