Endpoints
Copy Page
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
Request refund
Request refund
Install eSIM
Get eSIM
Get installation instructions
Monitor usage
Get usage (data, text & voice)
eSIM voucher
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
Endpoints
Copy Page
Manage eSIMs
Update eSIM brand
PUT
/v2/sims/{sim_iccid}/brand
This endpoint allows you to update assigned brand settings name of a specific eSIM from the Airalo Partners API using the eSIM's ICCID. This brand...
Get eSIMs list
GET
/v2/sims
:::highlight blue 💡GDPR and Data StorageFor compliance with GDPR and global privacy regulations, Airalo does not store any of your end-users' per...
Get eSIM package history
GET
/v2/sims/{iccid}/packages
:::highlight blue 💡GDPR and Data StorageFor compliance with GDPR and global privacy regulations, Airalo does not store any of your end-users' per...
Previous
Future Orders
Next
Update eSIM brand