Get eSIM package history - Airalo Developer Platform

**This endpoint comes with a Rate Limit:**you can pull specific eSIM history info once every 15 minutes.

If you send another request too soon, the server's going to respond with a 429 HTTP code. Please check the 'Retry-After' header, it'll tell you how many seconds to wait before the rate limit resets and you can fetch fresh info.

Please, use a caching mechanism on the client side to deal with frequent customer requests.

To get and display this eSIM’s data package history, including top-ups:

Make a GET request to the endpoint URL https://partners-api.airalo.com/v1/sims/:iccid/packages, replacing :iccid with the ICCID of the eSIM for which you want to retrieve top-up package information.

The API will respond with a JSON object containing an array of purchased top-up packages for the eSIM, each of which includes an ID, remaining data amount, activation and expiration dates, and other information.

For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ

Request

Path Params

iccid

string

required

eSIM ICCID, used to query a list of purchased packages, including top-ups. Required. Can be obtained by execuring GET to the "eSIMs List" endpoint

Example:

8910300000005271146

Header Params

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {{token}}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200eSIM: List purchased top-up packages (history): 200 OK

application/json

Body

data

array [object {7}]

required

integer

required

status

string

required

remaining

integer

required

activated_at

string

required

expired_at

string

required

finished_at

null

required

package

object

required

Example

{
  "data": [
    {
      "id": 728,
      "status": "ACTIVE",
      "remaining": 2378,
      "activated_at": "2023-01-09T10:30:45+00:00",
      "expired_at": "2023-02-09T10:30:45+00:00",
      "finished_at": null,
      "package": {
        "id": "bonbon-mobile-30days-3gb-topup",
        "type": "topup",
        "price": 10,
        "net_price": 6,
        "amount": 3072,
        "day": 30,
        "is_unlimited": false,
        "title": "3 GB - 30 Days",
        "data": "3 GB",
        "short_info": null
      }
    },
    {
      "id": 725,
      "status": "ACTIVE",
      "remaining": 2496,
      "activated_at": "2023-01-09T10:30:45+00:00",
      "expired_at": "2023-02-09T10:30:45+00:00",
      "finished_at": null,
      "package": {
        "id": "bonbon-mobile-30days-3gb-topup",
        "type": "topup",
        "price": 10,
        "net_price": 6,
        "amount": 3072,
        "day": 30,
        "is_unlimited": false,
        "title": "3 GB - 30 Days",
        "data": "3 GB",
        "short_info": null
      }
    }
  ]
}

🟢200eSIM: List purchased top-up packages (history): 404 (Invalid ICCID)

🟠429eSIM: List purchased top-up packages (history): 429 (Rate Limit)