Future orders

This endpoint allows you to submit an order to the Airalo Partner API, which will be created on the specified due date.

To proceed, provide the required information:

Due date

Quantity

Package ID

Description (optional)

Please note:

On success, the endpoint response will include a unique 25-character request_id.

You must store this value in your system to cancel the order later if needed and to know for which order you got a response on your webhook URL.

An access token from the "Request Access Token" endpoint is required in the request.

Delivery modes
What is a webhook URL?
Webhook URL is a URL that is configured on your domain and your won webserver.
That URL should be able to receive HTTP POST requests with your order data that will be sent from our servers .
NOTE: We check the liveness of your webhook URL with an HTTP HEAD request to which we expect 200 OK response.

What happens when the due date arrives?
When the due date arrives your order is processed and the order details are sent as a POST HTTP request to
either your opted in "async_orders" notification type url (more info here )
or on the "webhhok_url" optional parameter of this endpoint which overrides the above opted in URL.
NOTE that you must have one of the above (either opted in URL or webhhok_url) provided in order to make a future order.

if you provide the optional parameter "sharing_option", which goes together with the "to_email" parameter
then an email with the eSim details will also be sent to the email provided in the "to_email" parameter as well.
Depending from the selected sharing option which can be one of link or pdf or both you will get the eSim data
either in a PDF format attached to the email or as a link.

What is the format of the message that is sent to the webhook URL?
The format of the message that is sent to the webhook URL is the same as the response of the regular order.
It only has one additional parameter named "request_id" which is the same request_id that you got in the response
when you made the future order at the time of making the order,
so that you know for which future order you got details on your webhook URL.

SANBOX MODE

NOTE that this endpoint has a slightly different behaviour in sandbox mode.
Here are the differences.

In sandbox mode the future orders will not be processed on the actual due date but they will be processed immediatelly upon submission.

Because the future orders are not processed on the due date, their status is always processed so in order to simulate future orders with other statuses there are 3 special packages for that. Here are the pacakges with the explanations:

test-create-pending-future-order-7days-1gb - special package for creating a future order with pending status

test-create-failed-future-order-7days-1gb - special package for creating a future order with failed status

test-create-retry-future-order-7days-1gb - special package for creating a future order with retry status

By using the packages above future orders with the above statuses can be created and the request_id from those orders can be used to test the cancel future order API to cancel the future order.

By using the above packages you can also test the GET future orders API Endpoint to test the filters as well.

curl --location '/v2/future-orders' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {{token}}' \ --header 'url: https://partners-api.airalo.com' \ --header 'Content-Type: application/json' \ --data '{ "quantity": 1, "package_id": "change-7days-1gb", "due_date": "2025-04-09 10:00", "description": "Just a future order ..", "webhook_url": "http://somePartnerDomain.com/webhook-url-path-to-wait-for-the order-details" }'

{ "data": { "request_id": "9HrK4-KGgz8n71eGgdNS5cV7Y", "due_date": "2025-03-28 10:00", "latest_cancellation_date": "2025-03-27 10:00" }, "meta": { "message": "success" } }

Request

Responses