# Airalo Developer Platform ## Docs - OVERVIEW [Introduction](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/introduction-752219m0.md): - OVERVIEW [Attribute descriptions](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/attribute-descriptions-752392m0.md): - OVERVIEW [FAQ](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/faq-752238m0.md): - OVERVIEW > User journeys [Purchase journey](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/purchase-journey-752412m0.md): - OVERVIEW > User journeys [Top-up journey](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/top-up-journey-780781m0.md): - OVERVIEW > Guides [How to set up a brand for eSIMs Cloud link sharing](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-set-up-a-brand-for-esims-cloud-link-sharing-752805m0.md): - OVERVIEW > Guides [How to get the eSIMs Cloud sharing link through API](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-get-the-esims-cloud-sharing-link-through-api-752807m0.md): - OVERVIEW > Guides [How to generate the QR code for an eSIM](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-generate-the-qr-code-for-an-esim-752812m0.md): - OVERVIEW > Guides [How to share eSIM installation instructions with users](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-share-esim-installation-instructions-with-users-757118m0.md): - OVERVIEW > Guides [eSIM installation methods for API Partners](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/esim-installation-methods-for-api-partners-824105m0.md): - REST API [Introduction](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/introduction-752814m0.md): - REST API [Product updates](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/product-updates-752490m0.md): - REST API [Rate limits](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/rate-limits-752590m0.md): - REST API [Error handling](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/error-handling-780831m0.md): - REST API [Endpoints](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/endpoints-2663076f0.md): - REST API > Endpoints [Notifications](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/notifications-2508831f0.md): - REST API > Endpoints > Notifications [Airalo webhooks optin and flow](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/airalo-webhooks-optin-and-flow-930064m0.md): - REST API > Endpoints > Notifications [Understanding webhooks: Asynchronous communication for modern applications](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/understanding-webhooks-asynchronous-communication-for-modern-applications-930005m0.md): - REST API > Endpoints [Check balance](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/check-balance-2508832f0.md): - REST API > Guides [Step #1 - Authentication](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/step-1-authentication-752889m0.md): - SDKs [Introduction](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/introduction-752338m0.md): - SDKs [SDK vs. REST API](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/sdk-vs-rest-api-780793m0.md): - SDKs [Technical notes](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/technical-notes-752585m0.md): - WOOCOMMERCE PLUGIN [Introduction](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/introduction-780800m0.md): - WOOCOMMERCE PLUGIN [Product updates](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/product-updates-780809m0.md): - WOOCOMMERCE PLUGIN > Guides [How to install the plugin](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-install-the-plugin-752290m0.md): - WOOCOMMERCE PLUGIN > Guides [How to setup the Shop price?](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-setup-the-shop-price-752525m0.md): - WOOCOMMERCE PLUGIN > Guides [Customizing "My eSIM" page colors in WooCommerce](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/customizing-my-esim-page-colors-in-woocommerce-837035m0.md): - WOOCOMMERCE PLUGIN > Guides [How to convert prices into local currency](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-convert-prices-into-local-currency-752526m0.md): - WOOCOMMERCE PLUGIN > Guides [How to finalize the shop setup](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-finalize-the-shop-setup-752549m0.md): - WOOCOMMERCE PLUGIN > Guides [How to test in sandbox](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-test-in-sandbox-752550m0.md): - WOOCOMMERCE PLUGIN > Guides [How to go live](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-go-live-752552m0.md): - WOOCOMMERCE PLUGIN > Guides [TO DELETE Installation plugin backup](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/to-delete-installation-plugin-backup-776347m0.md): - WOOCOMMERCE PLUGIN > Guides [Customizing WooCommerce email templates for eSIM sales](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/customizing-woocommerce-email-templates-for-esim-sales-902363m0.md): - WOOCOMMERCE PLUGIN > Troubleshooting [Troubleshooting](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/troubleshooting-770182m0.md): - SHOPIFY APP [Introduction](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/introduction-935339m0.md): - SHOPIFY APP > Guides [How to install the Airalo Shopify App](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-install-the-airalo-shopify-app-935388m0.md): - SHOPIFY APP > Guides [How to set up prices in Shopify](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/how-to-set-up-prices-in-shopify-935504m0.md): ## API Docs - OVERVIEW > Quick start [Step 1: Request access token](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/step-1-request-access-token-11883017e0.md): ```mermaid - OVERVIEW > Quick start [Step 2: Get packages](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/step-2-get-packages-11883018e0.md): :::highlight blue 💡 - OVERVIEW > Quick start [Step 3: Submit order](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/step-3-submit-order-11883019e0.md): This endpoint allows you to submit an order to the Airalo Partners API. Provide the required information, such as quantity and package ID, and include optional description if needed. - OVERVIEW > Quick start [Step 4: Get installation instructions](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/step-4-get-installation-instructions-11883020e0.md): This endpoint allows you to retrieve the language specific installation instructions of a specific eSIM from the Airalo Partners API using the eSIM's ICCID. - REST API > Endpoints > Authenticate [Request access token](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/request-access-token-11883021e0.md): This endpoint provides an access token required for making authenticated requests to the Airalo Partners API. Submit your client ID and client secret to obtain a token valid for **24 hours**. While the token remains valid for a year, we recommend refreshing it more frequently for enhanced security. - REST API > Endpoints > Browse packages [Get packages](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-packages-11883036e0.md): :::highlight blue 💡 - REST API > Endpoints > Browse packages [Get compatible device list](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-compatible-device-list-11883037e0.md): This endpoint provides a comprehensive list of devices that are compatible with eSIMs. Use this information to ensure that your customers have devices that support eSIM functionality. - REST API > Endpoints > Place order [Submit order](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/submit-order-11883024e0.md): This endpoint allows you to submit an order to the Airalo Partners API. Provide the required information, such as quantity and package ID, and include optional description if needed. - REST API > Endpoints > Place order [Submit order async](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/submit-order-async-11883025e0.md): This endpoint allows you to submit an asynchronous order to the Airalo Partners API. This ensures greater performance and reduces the wait time for your desired flow. Each async order will generate unique `nanoid` stored in reponse's `request_id` - Make sure you store this id in your system, as it is a reference for the order which is pending processing. You should check map it for every successfully received order response on your webhook url. - REST API > Endpoints > Place order [Future orders](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/future-orders-14455445e0.md): This endpoint allows you to submit an order to the Airalo Partner API, which will be created on the specified due date. - REST API > Endpoints > Place order [eSIM voucher](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/esim-voucher-11883065e0.md): This endpoint allows you to create an esim voucher to the Airalo Partners API. Provide the required information, such as quantity and package id - REST API > Endpoints > Install eSIM [Get eSIM](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-esim-11883028e0.md): This endpoint allows you to retrieve the details of a specific eSIM from the Airalo Partners API using the eSIM's ICCID. Note that only eSIM orders made via the API are retrievable via this endpoint. You can include related data in the response by specifying optional parameters. - REST API > Endpoints > Install eSIM [Get installation instructions](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-installation-instructions-11883029e0.md): This endpoint allows you to retrieve the language specific installation instructions of a specific eSIM from the Airalo Partners API using the eSIM's ICCID. - REST API > Endpoints > Monitor usage [Get usage (data, text & voice)](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-usage-data-text-voice-11883030e0.md): **Endpoint do support new type of packages - "Voice and Text"** - REST API > Endpoints > Place top up order [Submit top-up order](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/submit-top-up-order-11883026e0.md): **To submit a top-up order:** - REST API > Endpoints > Place top up order [Get top-up package list](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-top-up-package-list-11883031e0.md): **Endpoint do support new type of packages - "Voice and Text"** - REST API > Endpoints > Place top up order [Get eSIMs list](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-esims-list-11883027e0.md): This endpoint allows you to retrieve a list of your eSIMs from the Airalo Partners API. You can customize the results using various filters and include related data in the response by specifying optional parameters. - REST API > Endpoints > Place top up order [Get eSIM package history](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-esim-package-history-11883032e0.md): **This endpoint comes with a Rate Limit:****you can pull specific eSIM history info once every 15 minutes.** - REST API > Endpoints > Manage orders & eSIMs [Get order list](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-order-list-11883022e0.md): This endpoint allows you to retrieve a list of your orders from the Airalo Partners API. By using various filters, you can customize the results to match specific criteria. The access token, obtained from the "Request Access Token" endpoint, should be included in the request. - REST API > Endpoints > Manage orders & eSIMs [Cancel future orders](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/cancel-future-orders-14459873e0.md): This endpoint allows you to submit future order cancellation requests via the Airalo Partner API. - REST API > Endpoints > Manage orders & eSIMs [Get order](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-order-11883023e0.md): This endpoint allows you to retrieve the details of a specific order from the Airalo Partners API using the order ID. You can also include related data in the response by specifying optional parameters. The access token, obtained from the "Request Access Token" endpoint, should be included in the request. - REST API > Endpoints > Manage orders & eSIMs [Update eSIM brand](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/update-esim-brand-11883033e0.md): 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 is used to apply branding on sharing link or share e-mails.If brand is set as null value, eSIM will be shared with unbranded visual. - REST API > Endpoints > Notifications [Async orders](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/async-orders-11883038e0.md): This feature allows you to subscribe to notifications regarding async orders. You will receive the order's data payload on your specified webhook url. It will also include Airalo's signature header which ensures maximum security it was us who send you this HTTP request (check [https://partners-doc.airalo.com/#827cb567-db17-484a-a484-5ca10b7fa41b](https://partners-doc.airalo.com/#827cb567-db17-484a-a484-5ca10b7fa41b)) - REST API > Endpoints > Notifications [Low data notification - opt In](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/low-data-notification-opt-in-11883039e0.md): This feature allows you to subscribe to notifications regarding low data usage. Alerts will be sent when your data usage reaches 75% and 90%. Additionally, notifications will be sent when there are 3 days and 1 day remaining before expiration. Notification is available via webhook or email. However, please note that this feature is designed to deliver notifications exclusively to partner email addresses and not directly to customers. Ensure that only a single email address (such as support or back office) is configured for this purpose - REST API > Endpoints > Notifications [Low data notification - opt out](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/low-data-notification-opt-out-11883040e0.md): This feature allows you to opt out of notifications regarding low data usage depending upon the type passed in the request payload - REST API > Endpoints > Notifications [Get low data notification](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-low-data-notification-11883041e0.md): This endpoint allows you to retrieve the details of low data notification from the Airalo Partners API. The access token, obtained from the "Request Access Token" endpoint, should be included in the request. - REST API > Endpoints > Notifications [Credit limit notification](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/credit-limit-notification-11883042e0.md): Receive notifications regarding your credit limit as it reaches specific thresholds. You have - REST API > Endpoints > Notifications [Webhook definition](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/webhook-definition-11883043e0.md): A webhook is a method in the context of Airalo's API, which serves as a means to seamlessly push real-time data updates to our partner's designated endpoint URL. This functionality ensures timely and efficient data synchronization between our systems and those of our valued partners. - REST API > Endpoints > Notifications [Webhook simulator](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/webhook-simulator-11883044e0.md): With this endpoint parthers can trigger a Low Data Notification webhook event with mock data to their opted-in wehbook url. This is useful during testing/integration phase where developers can test their server when receiving such events. - REST API > Endpoints > Check balance [Get balance](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/get-balance-11883045e0.md): This feature allow you to know your account balances, so you can have an overview on your financial portfolio. You can monitor my balances and can top-up my Airalo credit to avoid order failing due to Insufficient funds If there is no account, the response should be an empty array for the accounts - REST API > Endpoints > Refunds [Refund request](https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/refund-request-14583565e0.md): # Overview