Airalo Developer Platform
  1. Packages
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • 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
    • Endpoints
      • Orders List
        • Get order list
        • Get order
      • Top-up flow
        • Get eSIMs list
        • Get top-up package list
        • Get eSIM package history
      • Notification
        • Understanding Webhooks: Asynchronous Communication for Modern Applications
        • Airalo Webhooks Optin and Flow
        • Async orders
        • Low data notification - opt In
        • Low data notification - opt out
        • Get low data notification
        • Credit limit notification
        • Webhook definition
        • Webhook simulator
      • Balance
        • Get balance
      • Request access token
      • Get packages
      • Get compatible device list
      • Future Orders
      • eSIM voucher
      • Get eSIM
      • Cancel future orders
      • Submit order
      • Refund Request
      • Get installation instructions
      • Submit order async
      • Get usage (data, text & voice)
      • Submit top-up order
      • Update eSIM brand
    • Guides
      • Step #1 - Authentication
    • Deprecated
      • Authentication
        • Request Access Token
      • Orders
        • Get Order List
        • Get Order
        • Submit Order
        • Submit Top-up Order
      • eSIMs
        • Get eSIMs List
        • Get eSIM
        • Get Installation instructions
        • Get Data Usage
        • Get Top-up Package List
        • Get eSIM Package History
      • Order Statuses
        • Get Order Statuses List
        • Get Order Status Name
      • Packages
        • Get Packages
          GET
      • Compatible Devices
        • Get Compatible Device List
      • Notification
        • Low Data Notification
        • Credit Limit Notification
        • Webhook Definition
        • Webhook Simulator
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Product updates
    • Guides
      • How to install the plugin
      • How to setup the Shop price?
      • Customizing "My eSIM" page colors in WooCommerce
      • How to convert prices into local currency
      • How to finalize the shop setup
      • How to test in sandbox
      • How to go live
      • TO DELETE Installation plugin backup
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
      • Troubleshooting
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Packages

Get Packages

GET
/v1/packages
This endpoint comes with a Rate Limit:
you can send up to 40 requests during 1 minute.
This endpoint allows you to retrieve a list of local and global packages from the Airalo Partners API. Local packages include eSIMs for a single country, while global packages cover multiple countries and regions. You can filter the results by operator type or country code and adjust pagination settings.
The access token, obtained from the "Request Access Token" endpoint, should be included in the request.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/packages' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'
Response Response Example
200 - List Packages (200)
{
    "data": [
        {
            "slug": "united-states",
            "country_code": "US",
            "title": "United States",
            "image": {
                "width": 132,
                "height": 99,
                "url": "https://cdn.airalo.com/images/16291958-0de3-4142-b1ba-d2bb0aeb689c.png"
            },
            "operators": [
                {
                    "id": 569,
                    "style": "light",
                    "gradient_start": "#0f1b3f",
                    "gradient_end": "#194281",
                    "type": "local",
                    "is_prepaid": false,
                    "title": "Change",
                    "esim_type": "Prepaid",
                    "warning": null,
                    "apn_type": "automatic",
                    "apn_value": "wbdata",
                    "is_roaming": true,
                    "info": [
                        "Data-only eSIM.",
                        "Rechargeable online with no expiry.",
                        "Operates on T-Mobile(5G) and AT&T(LTE) networks in the United States of America."
                    ],
                    "image": {
                        "width": 1035,
                        "height": 653,
                        "url": "https://cdn.airalo.com/images/feb9ef43-b097-440b-bcf5-08df9e8ff823.png"
                    },
                    "plan_type": "data",
                    "activation_policy": "first-usage",
                    "is_kyc_verify": false,
                    "rechargeability": true,
                    "other_info": "This eSIM is for travelers to the United States. The coverage applies to all 50 states of the United States, and Puerto Rico.",
                    "coverages": [
                        {
                            "name": "US",
                            "networks": [
                                {
                                    "name": "AT&T",
                                    "types": [
                                        "LTE"
                                    ]
                                },
                                {
                                    "name": "T-Mobile",
                                    "types": [
                                        "5G"
                                    ]
                                }
                            ]
                        }
                    ],
                    "packages": [
                        {
                            "id": "change-7days-1gb",
                            "type": "sim",
                            "price": 4.5,
                            "amount": 1024,
                            "day": 7,
                            "is_unlimited": false,
                            "title": "1 GB - 7 Days",
                            "data": "1 GB",
                            "short_info": "This eSIM doesn't come with a phone number."
                        },
                        {
                            "id": "change-30days-3gb",
                            "type": "sim",
                            "price": 11,
                            "amount": 3072,
                            "day": 30,
                            "is_unlimited": false,
                            "title": "3 GB - 30 Days",
                            "data": "3 GB",
                            "short_info": "This eSIM doesn't come with a phone number."
                        },
                        {
                            "id": "change-30days-5gb",
                            "type": "sim",
                            "price": 16,
                            "amount": 5120,
                            "day": 30,
                            "is_unlimited": false,
                            "title": "5 GB - 30 Days",
                            "data": "5 GB",
                            "short_info": "This eSIM doesn't come with a phone number."
                        },
                        {
                            "id": "change-30days-10gb",
                            "type": "sim",
                            "price": 26,
                            "amount": 10240,
                            "day": 30,
                            "is_unlimited": false,
                            "title": "10 GB - 30 Days",
                            "data": "10 GB",
                            "short_info": "This eSIM doesn't come with a phone number."
                        }
                    ],
                    "countries": [
                        {
                            "country_code": "US",
                            "title": "United States",
                            "image": {
                                "width": 132,
                                "height": 99,
                                "url": "https://cdn.airalo.com/images/16291958-0de3-4142-b1ba-d2bb0aeb689c.png"
                            }
      

Request

Query Params
filter[type]
string 
optional
Optional. A string to filter packages by operator type. Possible values are "local" and "global".
If the filter is set to "global," the output will include only global and regional eSims. Global and regional packages do not use the "country_code" field, which will be empty. The "type" field in the operator object within the response will be set to "global." A package is considered worldwide if its "slug" field is set to "world" and regional if "slug" contains a region name, for example, "europe" or "Africa".
If the filter is set to "local," the response will contain only country-specific packages. To get the list of packages for a single country, you can use it in combination with filter[country] parameter. The "type" field in the operator object of the response will indicate a "local" type.
When the filter is not set, we return all types of eSIMs: local, regional, and global.
Example:
global
filter[country]
string 
optional
Optional. A string to filter packages by country code. Examples include US, DE, GB, IT, and UA.
Example:
TR
limit
string 
optional
Optional. An integer specifying how many items will be returned on each page.
page
string 
optional
Optional. An integer specifying the pagination's current page.
If the page is set to 2 or beyond, the response will have different format and contain an object representing the country's index in the list of packages.
Example:
1
Header Params
Accept
string 
required
Example:
application/json
Authorization
string 
required
Example:
Bearer {{token}}

Responses

🟢200List Packages (200)
application/json
Body
data
array [object {5}] 
required
slug
string 
required
country_code
string 
required
title
string 
required
image
object 
required
operators
array [object {22}] 
required
links
object 
required
first
string 
required
last
string 
required
prev
null 
required
next
string 
required
meta
object 
required
message
string 
required
current_page
integer 
required
from
integer 
required
last_page
integer 
required
path
string 
required
per_page
string 
required
to
integer 
required
total
integer 
required
🟢200List Global Packages (200)
🟢200List Local Packages (200)
🟢200List Local Packages for Specific Country (200)
🟢200List Packages with Pagination (200)
🟢200List Packages with Pagination page>=2 (200)
🟠422List Packages (422)
Modified at 2024-11-22 09:33:20
Previous
Get Order Status Name
Next
Get Compatible Device List
Built with