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

💡

This endpoint comes with a rate limit: 100 requests per minute (per unique iccid) and a built-in cache of 20 minutes

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.

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

Body

Example

{
    "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