curl --request GET \
--url https://apiv2.example.com/subscriptions/usage \
--header 'X-Api-Key: <api-key>'{
"items": [
{
"subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
"usage": {
"updatedAt": "2024-01-15T10:30:00Z",
"voice": {
"national": [
{
"name": "Unlimited National",
"callSeconds": 3600,
"callCount": 15,
"callRemainingSeconds": 32400,
"callTotalSeconds": 36000,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"roaming": [
{
"name": "Unlimited National",
"callSeconds": 3600,
"callCount": 15,
"callRemainingSeconds": 32400,
"callTotalSeconds": 36000,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"ild": [
{
"name": "ILD 100 Minutes",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"balance": 15.5,
"currency": "USD",
"expiryDate": "2025-12-31"
}
]
},
"sms": {
"national": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"roaming": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"ild": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
]
},
"mms": {
"national": [
{
"name": "100 MMS National",
"mmsCount": 10,
"mmsRemaining": 90,
"mmsTotal": 100,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"roaming": [
{
"name": "100 MMS National",
"mmsCount": 10,
"mmsRemaining": 90,
"mmsTotal": 100,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"ild": [
{
"name": "100 MMS National",
"mmsCount": 10,
"mmsRemaining": 90,
"mmsTotal": 100,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
]
},
"data": {
"national": [
{
"name": "Europe 10GB",
"dataBytesUsed": 3221225472,
"dataBytesRemaining": 7516192768,
"dataBytesTotal": 10737418240,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"rlahBytesUsed": 1073741824,
"rlahBytesRemaining": 4294967296,
"rlahBytesTotal": 5368709120,
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"roaming": [
{
"name": "Asia 5GB Roaming",
"dataBytesUsed": 1073741824,
"dataBytesRemaining": 4294967296,
"dataBytesTotal": 5368709120,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
]
}
}
}
]
}Retrieve current usage statistics for multiple subscriptions by providing their IDs.
curl --request GET \
--url https://apiv2.example.com/subscriptions/usage \
--header 'X-Api-Key: <api-key>'{
"items": [
{
"subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
"usage": {
"updatedAt": "2024-01-15T10:30:00Z",
"voice": {
"national": [
{
"name": "Unlimited National",
"callSeconds": 3600,
"callCount": 15,
"callRemainingSeconds": 32400,
"callTotalSeconds": 36000,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"roaming": [
{
"name": "Unlimited National",
"callSeconds": 3600,
"callCount": 15,
"callRemainingSeconds": 32400,
"callTotalSeconds": 36000,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"ild": [
{
"name": "ILD 100 Minutes",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"balance": 15.5,
"currency": "USD",
"expiryDate": "2025-12-31"
}
]
},
"sms": {
"national": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"roaming": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"ild": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
]
},
"mms": {
"national": [
{
"name": "100 MMS National",
"mmsCount": 10,
"mmsRemaining": 90,
"mmsTotal": 100,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"roaming": [
{
"name": "100 MMS National",
"mmsCount": 10,
"mmsRemaining": 90,
"mmsTotal": 100,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"ild": [
{
"name": "100 MMS National",
"mmsCount": 10,
"mmsRemaining": 90,
"mmsTotal": 100,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
]
},
"data": {
"national": [
{
"name": "Europe 10GB",
"dataBytesUsed": 3221225472,
"dataBytesRemaining": 7516192768,
"dataBytesTotal": 10737418240,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"rlahBytesUsed": 1073741824,
"rlahBytesRemaining": 4294967296,
"rlahBytesTotal": 5368709120,
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
],
"roaming": [
{
"name": "Asia 5GB Roaming",
"dataBytesUsed": 1073741824,
"dataBytesRemaining": 4294967296,
"dataBytesTotal": 5368709120,
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "ACTIVE",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z"
}
]
}
}
}
]
}An API key that grants access to the Connect API. You can create and manage API keys in the portal.
List of subscription IDs to retrieve usage for.
1 - 100 elementsUsage statistics for the requested subscriptions.
Usage information for each requested subscription.
Show child attributes