Get data usage

GET

/v2/sims/{sim_iccid}/usage

Endpoint do support new type of packages - "Voice and Text"
This endpoint comes with a Rate Limit: you can pull specific eSIM usage 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.

This endpoint enables you to retrieve the total data usage and usage details 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 Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Get Usage: 200

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

Request

Path Params

sim_iccid

string

required

The ICCID of the eSIM for which you want to retrieve the data usage details.

Header Params

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {{token}}

Responses

🟢200Get Usage: 200

application/json

Body

object {0}

🟠404Get Usage: 404 (Invalid ICCID)

🟠429Get Usage: 429 (Rate Limit)

Modified at 2025-01-31 10:00:49

Get eSIM

Get installation instructions