Attribute descriptions - Airalo Developer Platform

Attribute	Description
activation_code	When installing an eSIM manually, users need to enter an activation code in their device settings to complete the installation without scanning a QR code. To install and download the eSIM, the user must enter both the SM-DP+ address and the activation code on their device.
activation_policy	The policy under which the eSIM activation is managed, whether it's activated immediately after the installation or after the connection to any supported network (user arrives at a supported country).
airalo_code	The order number generated by Airalo for each purchase. You can find it under (API) Orders on the Partner Platform and in the CSV file attached to the invoice.
amount	The package’s included data allowance, in megabytes (MB). For unlimited packages, ignore this field. Use `is_unlimited` to determine whether a package is unlimited.
apn	APN (Access Point Name) helps the device connect to the internet. For some Airalo eSIMs, users may need to manually enter APN settings on their devices if the `apn_type` is set to manual. If needed, the APN value will be provided in the eSIM installation instructions.
apn_type	This defines whether the APN settings are applied automatically by the device or must be entered manually by the user. Automatic is based on the operating system 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	The identifier of a Brand Settings configuration created in the Partner Platform (Company Settings → Brand settings). Include this value when submitting an order or updating an eSIM brand to choose which partner brand is used for the end-user experience, including the eSIMs Cloud sharing link and related branded assets such as emails and PDFs. If omitted, the experience follows the account’s default behavior, such as using a default brand (if configured) or being unbranded.
code	The Airalo order code (e.g., `20241018-124189`). It is returned in order-related responses and can be used to reference and search for an order in the Partner Platform and invoices/CSV exports.
company	The business or legal entity associated with your Airalo account.
confirmation_code	Some eSIMs require entering a confirmation code at the activation due to the network provider (e.g., O2 in the Czech Republic). Without communicating this confirmation code to the end-user, the eSIM can't be activated.
contact_point	A webhook URL (your endpoint that receives notifications) or a notification email address.
countries	List of covered countries.
country_code	Two-character ISO country code. In some responses (e.g., regions or coverages), values may include legacy or territory identifiers that don't have a standard ISO mapping.
country_id	Numeric identifier for the country (internal Airalo country ID).
coverages	The mobile networks supported by the eSIM in each country.
created_at	Timestamp indicating when an order and eSIM were created (e.g., `2024-06-06 12:26:24`).
currency	Currency code used to display prices. You are billed in USD, but you can select a preferred currency in your account settings to see prices in that currency.
current_page	Current page number in a paginated response (navigation/paging metadata).
data	The package’s included data (e.g., `3 GB`). For unlimited packages, this value is `Unlimited`.
day	Number of days the package is valid for.
description	A custom description you can include when submitting an order or top-up order (e.g., your internal order ID or customer ID). You can later use this value to search orders via the Get Order List endpoint.
direct_apple_installation_url	Direct installation link for Apple devices (Universal link supported by iOS 17.4 or above).
email	Your email address registered in the Partner platform.
esim_type	Type of eSIM plan. Most eSIMs are `Prepaid`.
expired_at	Date and time when the package expires. eSIMs can still be topped up after expiration, provided the eSIM hasn't been recycled.
first	Pagination link to the first page of results.
from	Pagination metadata indicating where the current page starts in the full result set.
gradient_end	End color of a gradient, often used in the operator’s UI design. You don’t need to use Airalo’s default images or design.
gradient_start	Start color of a gradient, often used in the operator’s UI design. You don’t need to use Airalo’s default images or design.
height	The height dimension, usually used in images.
iccid	Unique identifier for the eSIM. Store this value and link it to your customer to use across endpoints, including Get eSIM, Get Installation Instructions, Get Top-up packages, and for submitting top-up orders.
id	An identifier for the object returned by the endpoint. Depending on the context, this can refer to a package ID, top-up package ID, or order ID.
image	Optional image details for the country or package (e.g., an image URL and its dimensions).
info	Additional operator information returned as a list of short text notes (e.g., details like whether a plan supports data, voice, and text, and if it can be topped-up).
installation_guides	Links to eSIM installation guides on Airalo’s website. You can also use the Get Installation Instructions endpoint instead.
installation_manual	Step-by-step eSIM installation instructions for manual installation. This field is multi-lingual.
installation_via_qr_code	Step-by-step eSIM installation instructions for QR code installation. This field is multi-lingual.
instructions	Step-by-step eSIM installation instructions to help end-users install their eSIM, based on their device’s operating system (iOS, Android) and device model. The instructions are the same as those used on airalo.com, Airalo's B2C platform, but provided in a white-label format. They are available in up to 53 languages, depending on the language specified in the API request.
is_kyc_verify	Indicates whether the package requires eKYC (electronic Know Your Customer) verification. eKYC-enabled packages aren’t offered via the Partner API.
is_prepaid	Indicates if the package is prepaid.
is_roaming	Indicates if the package requires roaming services. If required, end-users have to enable roaming on their device for the eSIM to connect to a network.
is_unlimited	Indicates if the data package provides unlimited usage.
language	Language of the installation instructions.
last	Pagination link to the last page of results.
last_page	Last page number in a paginated response.
levels	Notification level settings returned during opt-in or opt-out operations.
links	Collection of pagination links returned in a paginated response (e.g., first, last, next, previous).
lpa	Also known as SMDP address, can be used for manual installation.
manual_installation	Contains the eSIM installation instructions as HTML-formatted text.
matching_id	Activation code used for manual eSIM installation.
message	Warning or error message returned by the endpoint.
meta	Response metadata indicating whether the request succeeded or failed.
model	Device model used to return the correct 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	The wholesale (net) price charged to you by Airalo.
network_setup	Information about whether the network setup is required during installation (e.g., roaming or manual APN setup).
networks	List of mobile networks supported by the eSIM.
next	Pagination link to the next page of results.
notification	Notification details returned for opt-in or opt-out events.
operators	List of operators that offer the plans/packages.
other_info	Additional information about the eSIM plan.
package	Package summary showing what is included (e.g., `3 GB - 30 Days`), without the Airalo package name.
package_id	Package unique identifier. Use this value when submitting an order, or to reference a package in your system.
packages	List of packages provided under an operator.
path	Path returned in the pagination metadata for the current response.
per_page	Number of items returned per page in a paginated response.
plan_type	The type of package (e.g., data-only, or data with voice and text).
prev	Pagination link to the previous page of results.
price	Recommended retail price (the minimum price you can sell at).
qr_code_data	Data that can be used to generate a custom QR code.
qr_code_url	URL of the QR code (served from airalo.com).
qr_installation	QR-based installation instructions in English. For a multi-lingual experience, use the multi-lingual installation guides.
quantity	Number of eSIMs or packages included in the transaction.
rechargeability	Indicates whether the eSIM or package can be topped up.
remaining	Remaining data balance.
remaining_text	Remaining SMS/text messages.
remaining_voice	Remaining voice/calls (in minutes).
short_info	Short summary of the eSIM package, including limitations.
smdp_address	SMDP address that can be used during manual installations.
smdp_address_and_activation_code	When installing an eSIM manually, the user needs to input both: SM-DP+ address. This tells the device where to download the eSIM from. Activation Code, this refers to the Matching ID, which identifies the specific eSIM profile to be installed. Both values must be entered manually by the end-user in their device settings during the eSIM installation.
status	Status of the eSIM or package (e.g., active, expired).
steps	Step-by-step actions in the installation process (manual, QR, or network setup).
text	Number of SMS/text messages included in the package.
total	Total amount of data included in the package.
total_text	Total SMS/text messages included in the package.
total_voice	Total voice/calls (in minutes) included in the package.
type	Indicates the package type (e.g., eSIM or top-up).
types	Supported network types by the operator (e.g., 3G, 4G, 5G).
url	URL of an optional image (e.g., for a country or operator).
validity	The validity of a package (in days).
version	Operating system version (iOS or Android).
voice	Number of voice minutes included in the package.
voucher_code	Voucher code that can be shared with users for voucher-based purchases.
warning	Warning message returned by the endpoint.
width	Image width dimension.
install_window_days	The number of days from when an eSIM is bought until it can be installed on a device. If this period passes, the eSIM is recycled and can no longer be used or topped up.
topup_grace_window_days	The number of days after an eSIM is exhausted or expired during which it can still be topped up. If no top-up is purchased within this period, the eSIM is recycled and can no longer be topped up. This period restarts after each top-up.