Submit top-up order

To submit a top-up order:

This endpoint allows you purchase a top-up package for a specific eSIM providing the below parameters to your request:

package_id: The ID of the top-up package you want to purchase.

iccid: The ICCID of the eSIM for which you want to purchase the top-up package.

You can also include an optional description field to provide additional information about the order.

The API will respond with a JSON object containing the details of the order, including the package ID, quantity, price, and other relevant information.

The complete workflow for buying a top-up package:

Call the GET eSIMS list to see the list of previously purchased eSIMs

Call the Get top-up package list to see the list of available top-ups for the eSIM providing its iccid you retrieved from point 1.

Submit an order on Submit top-up order endpoint
with the iccid you wish to buy the top-up package for, and provide also package_idof the top-up package to purchase.

Call the Get eSIM package history endpoint
to see the list of all packages bought for that eSIM.

For more information and best practices visit our FAQ page

application/json

Bodyapplication/json

Examples

Submit Top-up Order: 200 OKSubmit Top-up Order: 422 (Purchase limit exceeded)Submit Top-up Order: 422 (Required fields are missing)Submit Top-up Order: 422 (Invalid package id)Example 1

{
    "data": {
        "id": 111,
        "code": "20251118-000111",
        "package_id": "change-7days-1gb-topup",
        "currency": "USD",
        "quantity": 1,
        "type": "topup",
        "description": "Topup (873000000000042542)",
        "esim_type": "local",
        "validity": 7,
        "package": "Change-1 GB - 7 Days",
        "data": "1 GB",
        "price": 4.5,
        "pricing_model": "net_pricing",
        "text": null,
        "voice": null,
        "net_price": 3.6,
        "created_at": "2025-11-18 13:37:07",
        "manual_installation": "<p><b>eSIM name:</b> Change</p><p><b>Coverage: </b>United States</p><p><b>To manually activate the eSIM on your eSIM capable device:</b></p><ol><li>Settings > Cellular/Mobile > Add Cellular/Mobile Plan.</li><li>Manually enter the SM-DP+ Address and activation code.</li><li>Confirm eSIM plan details.</li><li>Label the eSIM.</li></ol><p><b>To access Data:</b></p><ol><li>Enable data roaming.</li></ol>",
        "qrcode_installation": "<p><b>eSIM name:</b> Change</p><p><b>Coverage: </b>United States</p><p><b>To activate the eSIM by scanning the QR code on your eSIM capable device you need to print or display this QR code on other device:</b></p><ol><li>Settings > Cellular/Mobile > Add Cellular/Mobile Plan.</li><li>Scan QR code.</li><li>Confirm eSIM plan details.</li><li>Label the eSIM.</li></ol><p><b>To access Data:</b></p><ol><li>Enable data roaming.</li></ol>",
        "installation_guides": {
            "en": "https://www.airalo.com/help/getting-started-with-airalo"
        }
    },
    "meta": {
        "message": "success"
    }
}

Request

Request Code Samples

Responses