eSIMs · Objects

The eSIM booking object

An eSIM booking is one eSIM order or one topup of your agency: who it is for, what was bought, what it cost and which supplier fulfilled it.

GET /esims/bookings lists the orders and GET /esims/bookings/{iccid}/topup-history the topups.

total_price is what you charge the traveler and agency_commission is your commission as an amount: the amount debited from your balance is total_price minus agency_commission. A failed attempt is kept with the status failed and an ICCID that starts with PENDING-.

Example

{
  "id": "639417b4-b103-4ece-bd5d-850315322278",
  "booking_id": "FX-1793546602916",
  "order_id": "20261101-106852",
  "status": "confirmed",
  "currency": "DZD",
  "total_price": 468.84,
  "agency_commission": 50.24,
  "type": "esim",
  "package_name": "1 GB - 7 days • France",
  "iccid": "8900000540463077957",
  "customer_email": "[email protected]",
  "customer_first_name": "John",
  "customer_last_name": "Smith",
  "customer_phone": "+15555550123",
  "provider_name": "Airalo",
  "supplier_id": "airalo",
  "created_at": "2026-11-01T15:23:22.961228+00:00",
  "updated_at": "2026-11-01T15:23:22.961228+00:00",
  "environment": "sandbox"
}

Attributes

idstring (uuid)

Internal id of the booking row (UUID). It is the id the account history returns.

booking_idstring

The FX-Port booking reference, FX- followed by a number. Use it to look the booking up.

order_idstring

The supplier's order code of the eSIM or of the topup.

statusstring

State of the booking: confirmed, or failed when the supplier refused the order (those rows have an ICCID that starts with PENDING-).

One of confirmed, failed.

currencystring

Currency of the amounts: the settlement currency of your agency.

total_pricenumber

The price to charge the traveler.

agency_commissionnumber

Your commission as an amount, in your agency currency. The amount debited from your balance is total_price minus this.

typestring

esim for an order, topup for a topup.

One of esim, topup.

package_namestring

Name of the package, with the destination for an eSIM: 1 GB - 7 days • France.

iccidstring

The ICCID of the eSIM. A topup row carries the ICCID that was topped up.

customer_emailstring

The traveler's email address.

customer_first_namestring

The traveler's first name.

customer_last_namestring

The traveler's last name.

customer_phonestring

The traveler's phone number.

provider_namestring

Name of the supplier that fulfilled the booking.

supplier_idstring

Id of the supplier that fulfilled the booking. Here airalo: the supplier list calls the same supplier airalo_1.

created_atstring

When the booking was created: ISO 8601, UTC.

updated_atstring

When the booking last changed: ISO 8601, UTC.

environmentstring

The environment of the booking.

One of sandbox, live.

{ "id": "639417b4-b103-4ece-bd5d-850315322278", "booking_id": "FX-1793546602916", "order_id": "20261101-106852", "status": "confirmed", "currency": "DZD", "total_price": 468.84, "agency_commission": 50.24, "type": "esim", "package_name": "1 GB - 7 days • France", "iccid": "8900000540463077957", "customer_email": "[email protected]", "customer_first_name": "John", "customer_last_name": "Smith", "customer_phone": "+15555550123", "provider_name": "Airalo", "supplier_id": "airalo", "created_at": "2026-11-01T15:23:22.961228+00:00", "updated_at": "2026-11-01T15:23:22.961228+00:00", "environment": "sandbox" }