Attribute descriptions
| Attribute | Description |
|---|---|
| activation_code | Information that can be used during manual eSIM installation (requires SMDP+address and activation code) |
| activation_policy | Defines the policy under which the eSIM activation is managed, whether it is activated immediately after the installation or after the connection to any supported network |
| airalo_code | Order number, can be found also on the invoices. |
| amount | Amount of the data included in the plan in MBytes. |
| apn | Provides the information regarding the APN settings |
| apn_type | Automatic/Manual. In case of “automatic” the apn is always set automatically on the OS - always use the mobile OS Specific value (Android or iOS) |
| apn_value | In case of manual APN type, the user should set the APN manually, and the value given here should be set |
| brand_settings_name | Brand name in case of eSIMs cloud link will be used. In case of empty value is given, either non-branded eSIMs cloud link will be given or the default brand will be used |
| city | (Ignorable, not used) |
| code | Order number eg. "20241018-124189", also can be found on the Get Order endpoint and on the invoices |
| company | (Ignorable, not used) |
| confirmation_code | Specific plans might require additional confirmation code. As of now these packages are not available for Partners |
| contact_point | Webhook URL that points to the partner webhook implementation or partner email for notifications |
| countries | List of covered countries |
| country_code | 2 chars ISO country code |
| country_id | 2 chars ISO country code |
| coverages | Network coverages |
| created_at | Timestamp when the order and the eSIM has been created. eg. 2024-06-06 12:26:24 |
| currency | Always USD, we have all prices in USD as of now |
| current_page | Navigation on the response (paging) |
| data | Example "3 GB" indicates the data included in the package together with the “GB” |
| day | Number of days, refers to the validity of the package/plan |
| description | Custom description can be used for the submit order and submit top-up order. You can use your own original order id or customer id. It can be used for searching orders (Get Order List endpoint) |
| direct_apple_installation_url | Direct URL for Apple devices to install the eSIM profile (Universal link supported by iOS 17.4 or above) |
| (Ignorable, not used) | |
| esim_type | Mostly prepared |
| expired_at | When the package expires in date-time format. Keep in mind, only the package will expire, the eSIM can be top-up after the current package is expired |
| first | Navigation on the response (paging) |
| from | Navigation on the response (paging) |
| gradient_end | Represents the end colour of a gradient, often used in UI design of the operator (it is not required to use the image and design from the Airalo) |
| gradient_start | Represents the start colour of a gradient, often used in UI design of the operator (it is not required to use the image and design from the Airalo) |
| height | The height dimension, usually used in images (optional, see the “image”) |
| iccid | Unique identifier for the eSIM, must be stored on the partner side and link to a customer. It can be reused in multiple endpoints such as Get eSIM, Get Installation Instruction, Get Top-up packages, etc. |
| id | Can refer to package id, top-up package id or order id |
| image | Information on the optionally used image for the country or the plan |
| imsis | |
| info | Information about the operator |
| installation_guides | It can be ignored, contains link to Airalo website. Suggesting to use the Get Installation instruction endpoint |
| installation_manual | Step-by-step guides for the manual installation - multi-lingual |
| installation_via_qr_code | Step-by-step guides for the QR code based installation - multi-lingual |
| instructions | List of instructions on the requested language for various OS (iOS, Android) and mobile devices |
| is_kyc_verify | Flag about if the package requires eKYC. Currently all of our packages are free from requiring eKYC |
| is_prepaid | Indicates if the package or plan is prepaid. |
| is_roaming | Specifies whether the package requires roaming services, if “yes” the user has to enable roaming for the eSIM |
| is_unlimited | Indicates if the data package provides unlimited usage. |
| language | Language of the installation instruction |
| last | Navigation on the response (paging) |
| last_page | Navigation on the response (paging) |
| levels | Notification levels during opt-in/out |
| links | Navigation on the response (paging) |
| lpa | Also known as SMDP address, can be used for manual installation |
| manual_installation | |
| matching_id | Also known as Activation code, can be used for manual installation |
| message | Warning or error message returned by the endpoint |
| meta | Success or failed - indicates the status of the response |
| mobile | Not used, can be ignored |
| model | Indicates the mobile model in the Get Installation Instructions |
| msisdn | Phone number in case the plan contains voice option |
| name | Used in various ares, such as network name, country name, user name (can be ignored) |
| net_price | Refers to the wholesale price. |
| network_setup | Provides information about whether the network setup is required during installation (e.g., roaming or manual APN setup). |
| networks | List of supported networks. |
| next | Navigation on the response (paging). |
| notification | Details about the opt-in/out notification. |
| operators | List of operators that offer the plans/packages. |
| other_info | Further information about the eSIM plan. |
| package | Example: "3 GB - 30 Days" - Provides information/title for a package without the Airalo package name, just what is included. |
| package_id | ID of the eSIM plan, can be used for package ordering. Always a unique ID. |
| packages | List of packages/plans provided by the operators. |
| path | Navigation on the response (paging). |
| per_page | Navigation on the response (paging). |
| plan_type | Informs about the eSIM plan type, such as data (data-only packages), data-voice (data and calls included), etc. |
| postal_code | (Ignorable, not used). |
| prev | Navigation on the response (paging). |
| price | Always refers to the recommended retail price. |
| qr_code_data | Data that can be used to generate a custom QR code. |
| qr_code_url | URL for the QR code (served from airalo.com). |
| qr_installation | Contains instructions in English about QR-based installations. Recommended to use multi-lingual guides for eSIM installations. |
| quantity | Number of eSIMs or data packages associated with the transaction. |
| rechargeability | Indicates whether the eSIM or plan can be recharged. |
| remaining | Data usage, remaining data. |
| remaining_text | Data usage remaining text/SMS. |
| remaining_voice | Data usage, remaining voice/calls in minutes. |
| short_info | Short summary information on eSIM packages, including limitations. |
| smdp_address | SMDP address that can be used during manual installations. |
| smdp_address_and_activation_code | SMDP address and the activation code together for manual installations. |
| status | Provides information about the eSIM package status (e.g., expired, active). |
| steps | Steps within the installation process (manual, QR, network setup). |
| style | Design of the operator (optional). |
| text | Number of SMS messages included in the plan. |
| total | Total amount of the data package. |
| total_text | Number of SMS as part of the package. |
| total_voice | Minutes included for voice calls as part of the package. |
| type | Indicates the type of the package (e.g., eSIM or top-up). |
| types | Network types for the operators (e.g., 3G, 4G, 5G). |
| url | Refers to the URL of optionally used images (countries, operators). |
| user | (Ignorable, refers to the technical user, not the customer). |
| validity | The plan validity in days. |
| version | iOS or Android version. |
| voice | Number of minutes included in the plan. |
| voucher_code | Voucher code that can be shared with users in case of eSIM voucher purchases. |
| warning | Warning message returned by the endpoint. |
| width | The width dimension, usually used in images (optional). |
Last modified: 23 days ago