Skip to main content
GET
/
subscriptions
/
usage
Get usage for multiple subscriptions
curl --request GET \
  --url https://apiv2.example.com/subscriptions/usage \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
      "usage": {
        "callCount": 15,
        "callSeconds": 3600,
        "smsCount": 25,
        "period": {
          "startDate": "2025-09-10",
          "endDate": "2025-10-09"
        },
        "updatedAt": "2024-01-15T10:30:00Z",
        "dataBytes": {
          "remaining": 1073741824,
          "limit": 5368709120
        },
        "topupBytes": {
          "remaining": 1073741824,
          "limit": 5368709120
        },
        "ildTopup": {
          "balance": 15.5,
          "currency": "USD",
          "expiryDate": "2024-12-31"
        },
        "hotspotDataBytes": {
          "remaining": 1073741824,
          "limit": 5368709120
        },
        "hotspotTopupBytes": {
          "remaining": 1073741824,
          "limit": 5368709120
        }
      }
    }
  ],
  "aggregate": {
    "callCount": 15,
    "callSeconds": 3600,
    "smsCount": 25,
    "period": {
      "startDate": "2025-09-10",
      "endDate": "2025-10-09"
    },
    "updatedAt": "2024-01-15T10:30:00Z",
    "dataBytes": {
      "remaining": 1073741824,
      "limit": 5368709120
    },
    "topupBytes": {
      "remaining": 1073741824,
      "limit": 5368709120
    },
    "ildTopup": {
      "balance": 15.5,
      "currency": "USD",
      "expiryDate": "2024-12-31"
    },
    "hotspotDataBytes": {
      "remaining": 1073741824,
      "limit": 5368709120
    },
    "hotspotTopupBytes": {
      "remaining": 1073741824,
      "limit": 5368709120
    }
  }
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

​
subscriptionIds
string[]
required

List of subscription IDs to retrieve usage for.

Required array length: 1 - 100 elements
​
aggregate
boolean
default:false

Whether to include aggregated usage totals in addition to individual subscription usage.

Response

Usage statistics for the requested subscriptions.

​
items
object[]
required

Usage information for each requested subscription.

​
aggregate
object

Combined usage totals across all requested subscriptions. Only included when aggregate=true.