Get usage (data, text & voice) - Airalo Developer Platform

💡

This endpoint comes with a rate limit:

10 requests per minute (per unique iccid)

5 requests per second (per unique company)

A built-in cache of 20 minutes is also set on this endpoint's response.

This endpoint enables you to retrieve the total data, voice & text usage for a specific eSIM identified by its ICCID.

The access token, obtained from the "Request Access Token" endpoint, should be included in the request.

Note for unlimited packages

For unlimited packages the remaining, total and amount fields will default to 0 should be ignored, and not displayed to the end users.

When in Sandbox mode, the is_unlimited field can be false for an unlimited package ordered, due to not having real eSIMs available, thus don't reflect real usage.

Response atttributes units explained:

total : Response value is total megabytes on package

remaining : Response value is in total megabytes remaining

total_text : Response value is the initial total text messages on package

remaining_text : Response value is in total number of text messages remaining

total_voice : Response value is the initial total voice minutes on package

remaining_voice : Response value is in total minutes remaining

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Get Usage: 200

application/json

Bodyapplication/json

Examples

Get Usage: 200Get Usage: 404 (Invalid ICCID)Get Usage: 429 (Rate Limit)Success

{
    "data": {
        "remaining": 767,
        "total": 2048,
        "expired_at": "2022-01-01 00:00:00",
        "is_unlimited": true,
        "status": "ACTIVE", // All Cases: [ NOT_ACTIVE, ACTIVE, FINISHED, UNKNOWN, EXPIRED ]
        "remaining_voice": 0,
        "remaining_text": 0,
        "total_voice": 0,
        "total_text": 0
    },
    "meta": {
        "message": "api.succes"
    }
}

🟠404Get Usage: 404 (Invalid ICCID)

🟠429Get Usage: 429 (Rate Limit)

🟢200Get Usage (Recycled sim): 200