Skip to main content
GET
/
subscriptions
/
{subscriptionId}
/
usage
{
  "dataBytes": {
    "remaining": 1073741824,
    "limit": 5368709120
  },
  "topupBytes": {
    "remaining": 1073741824,
    "limit": 5368709120
  },
  "callCount": 15,
  "callSeconds": 3600,
  "smsCount": 25,
  "period": {
    "startDate": "2025-09-10",
    "endDate": "2025-10-09"
  },
  "ildTopup": {
    "balance": 15.5,
    "currency": "USD",
    "expiryDate": "2024-12-31"
  },
  "hotspotDataBytes": {
    "remaining": 1073741824,
    "limit": 5368709120
  },
  "hotspotTopupBytes": {
    "remaining": 1073741824,
    "limit": 5368709120
  },
  "updatedAt": "2024-01-15T10:30:00Z"
}

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.

Path Parameters

​
subscriptionId
string
required

The unique identifier for the subscription.

Response

Current usage statistics for the subscription.

Current usage statistics for a subscription's services including data, calls, and SMS.

​
callCount
integer
required

The number of calls made.

Example:

15

​
callSeconds
integer
required

The total duration of calls in seconds.

Example:

3600

​
smsCount
integer
required

The number of SMS messages sent.

Example:

25

​
period
object
required

The billing period this usage data covers.

​
updatedAt
string<date-time>
required

When the usage information was last updated.

Example:

"2024-01-15T10:30:00Z"

​
dataBytes
object

Regular data usage from the subscription plan.

​
topupBytes
object

Additional data purchased as top-ups.

​
ildTopup
object

International long distance calling top-up information, if applicable.

​
hotspotDataBytes
object

Data usage specifically for hotspot/tethering functionality.

Only applicable if the subscription plan includes hotspot capabilities.

​
hotspotTopupBytes
object

Additional hotspot data purchased as top-ups.

Only applicable if the subscription plan includes hotspot capabilities.

⌘I