Get usage for multiple subscriptions
curl --request GET \
--url https://apiv2.example.com/subscriptions/usage \
--header 'X-Api-Key: <api-key>'import requests
url = "https://apiv2.example.com/subscriptions/usage"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://apiv2.example.com/subscriptions/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiv2.example.com/subscriptions/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apiv2.example.com/subscriptions/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apiv2.example.com/subscriptions/usage")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.example.com/subscriptions/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
],
"roaming": [
{
"name": "Unlimited National",
"callSeconds": 3600,
"callCount": 15,
"callRemainingSeconds": 32400,
"callTotalSeconds": 36000,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
],
"ild": [
{
"name": "ILD 100 Minutes",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"balance": 15.5,
"currency": "USD",
"expiryDate": "2025-12-31",
"metadata": {}
}
]
},
"sms": {
"national": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
],
"roaming": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
],
"ild": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
]
},
"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",
"metadata": {}
}
],
"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",
"metadata": {}
}
],
"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",
"metadata": {}
}
]
},
"data": {
"national": [
{
"name": "Europe 10GB",
"dataBytesUsed": 3221225472,
"dataBytesRemaining": 7516192768,
"dataBytesTotal": 10737418240,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"rlahBytesUsed": 1073741824,
"rlahBytesRemaining": 4294967296,
"rlahBytesTotal": 5368709120,
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
],
"roaming": [
{
"name": "Asia 5GB Roaming",
"dataBytesUsed": 1073741824,
"dataBytesRemaining": 4294967296,
"dataBytesTotal": 5368709120,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
]
}
}
}
]
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}Subscription Usage
Get usage for multiple subscriptions
Retrieve current usage statistics for multiple subscriptions by providing their IDs.
GET
/
subscriptions
/
usage
Get usage for multiple subscriptions
curl --request GET \
--url https://apiv2.example.com/subscriptions/usage \
--header 'X-Api-Key: <api-key>'import requests
url = "https://apiv2.example.com/subscriptions/usage"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://apiv2.example.com/subscriptions/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiv2.example.com/subscriptions/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apiv2.example.com/subscriptions/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apiv2.example.com/subscriptions/usage")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.example.com/subscriptions/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
],
"roaming": [
{
"name": "Unlimited National",
"callSeconds": 3600,
"callCount": 15,
"callRemainingSeconds": 32400,
"callTotalSeconds": 36000,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
],
"ild": [
{
"name": "ILD 100 Minutes",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"balance": 15.5,
"currency": "USD",
"expiryDate": "2025-12-31",
"metadata": {}
}
]
},
"sms": {
"national": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
],
"roaming": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
],
"ild": [
{
"name": "500 SMS National",
"smsCount": 25,
"smsRemaining": 475,
"smsTotal": 500,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
]
},
"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",
"metadata": {}
}
],
"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",
"metadata": {}
}
],
"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",
"metadata": {}
}
]
},
"data": {
"national": [
{
"name": "Europe 10GB",
"dataBytesUsed": 3221225472,
"dataBytesRemaining": 7516192768,
"dataBytesTotal": 10737418240,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"rlahBytesUsed": 1073741824,
"rlahBytesRemaining": 4294967296,
"rlahBytesTotal": 5368709120,
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
],
"roaming": [
{
"name": "Asia 5GB Roaming",
"dataBytesUsed": 1073741824,
"dataBytesRemaining": 4294967296,
"dataBytesTotal": 5368709120,
"status": "ACTIVE",
"subscriptionAddonId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"validFrom": "2025-01-01T00:00:00Z",
"validTo": "2025-02-01T00:00:00Z",
"metadata": {}
}
]
}
}
}
]
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}Authorizations
apiKeybearerAuth & apiKey
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.
Required array length:
1 - 100 elementsResponse
Usage statistics for the requested subscriptions.
Usage information for each requested subscription.
Show child attributes
Show child attributes