Get usage (data, text & voice)

GET

/v2/sims/{sim_iccid}/usage

Endpoint do support new type of packages - "Voice and Text"

💡

This endpoint comes with a rate limit: 100 requests per minute (per unique iccid)

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.

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

Request

Path Params

Header Params

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/v2/sims//usage' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

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

Modified at 2025-07-28 10:12:18

Get installation instructions

Submit top-up order