Get eSIM package history - Airalo Developer Platform

💡

GDPR and Data Storage
For compliance with GDPR and global privacy regulations, Airalo does not store any of your end-users' personally identifiable information (PII). You are solely responsible for handling and storing all customer data on your end.

Associating eSIMs with Customers
To retrieve or manage all eSIMs associated with a specific customer, you must store and map the customer's data to the ICCID within your own system. The ICCID is the primary identifier for managing an eSIM post-purchase.

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 Code 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

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)