Skip to main content
GET
/
subscriptions
/
{subscriptionId}
/
usage
Get subscription usage
curl --request GET \
  --url https://apiv2.example.com/subscriptions/{subscriptionId}/usage \
  --header 'X-Api-Key: <api-key>'
{
  "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": {}
      }
    ]
  }
}

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 identifier of the subscription. May be the entity's internal UUID or an external reference identifier. Reference identifiers MUST be prefixed with rid_ (e.g., rid_crm-subscription-12345) so the API can distinguish them from internal UUIDs. The prefix is stripped before lookup.

Response

Current usage statistics for the subscription.

Current usage statistics for a subscription, organized by service type with per-package breakdown.

​
updatedAt
string<date-time>
required

When the usage information was last updated.

Example:

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

​
voice
object

Voice call usage across all scopes and packages.

​
sms
object

SMS usage across all scopes and packages.

​
mms
object

MMS usage across all scopes and packages.

​
data
object

Data usage across all scopes and packages.