A valid request URL is required to generate request examples{
"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
}
}
}Get usage for multiple subscriptions
Retrieve current usage statistics for multiple subscriptions by providing their IDs.
A valid request URL is required to generate request examples{
"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
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Query Parameters
List of subscription IDs to retrieve usage for.
1 - 100 elementsWhether to include aggregated usage totals in addition to individual subscription usage.
Response
Usage statistics for the requested subscriptions.
Usage information for each requested subscription.
Show child attributes
Show child attributes
The unique identifier for the subscription.
"123e4567-e89b-12d3-a456-426614174000"
Current usage statistics for a subscription's services including data, calls, and SMS.
Show child attributes
Show child attributes
The number of calls made.
15
The total duration of calls in seconds.
3600
The number of SMS messages sent.
25
When the usage information was last updated.
"2024-01-15T10:30:00Z"
International long distance calling top-up information, if applicable.
Show child attributes
Show child attributes
The remaining balance for international long distance calling top-ups.
Only applicable if the subscription plan includes ILD top-up capabilities.
15.5
The currency of the ILD top-up balance.
"USD"
The date when the international long distance calling top-up balance expires.
Only applicable if the subscription plan includes ILD top-up capabilities.
"2024-12-31"
Data usage specifically for hotspot/tethering functionality.
Only applicable if the subscription plan includes hotspot capabilities.
Additional hotspot data purchased as top-ups.
Only applicable if the subscription plan includes hotspot capabilities.
Combined usage totals across all requested subscriptions. Only included when aggregate=true.
Show child attributes
Show child attributes
The number of calls made.
15
The total duration of calls in seconds.
3600
The number of SMS messages sent.
25
When the usage information was last updated.
"2024-01-15T10:30:00Z"
International long distance calling top-up information, if applicable.
Show child attributes
Show child attributes
The remaining balance for international long distance calling top-ups.
Only applicable if the subscription plan includes ILD top-up capabilities.
15.5
The currency of the ILD top-up balance.
"USD"
The date when the international long distance calling top-up balance expires.
Only applicable if the subscription plan includes ILD top-up capabilities.
"2024-12-31"
Data usage specifically for hotspot/tethering functionality.
Only applicable if the subscription plan includes hotspot capabilities.
Additional hotspot data purchased as top-ups.
Only applicable if the subscription plan includes hotspot capabilities.