Subscription quota threshold exceeded

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.

Body

application/json

eventId

string<uuid>

required

Unique identifier for this event (stable for the logical event; multiple delivery attempts reuse the same id). Use for idempotency.

Example:

"b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab"

type

string

required

Event type identifier (dot namespaced, e.g. subscription.created).

Allowed value: "subscription.usage.thresholdExceed"

occurredAt

string<date-time>

required

RFC 3339 timestamp when the underlying change occurred.

data

object

required

Current usage snapshot at threshold crossing.

Show child attributes

data.callCount

integer<int64>

required

The number of calls made.

Example:

15

data.callSeconds

integer<int64>

required

The total duration of calls in seconds.

Example:

3600

data.smsCount

integer<int64>

required

The number of SMS messages sent.

Example:

25

data.period

object

required

The billing period this usage data covers.

Show child attributes

data.period.startDate

string<date>

required

The start date of the billing period.

Example:

"2025-09-10"

data.period.endDate

string<date>

required

The end date of the billing period.

Example:

"2025-10-09"

data.updatedAt

string<date-time>

required

When the usage information was last updated.

Example:

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

data.dataBytes

object

Regular data usage from the subscription plan.

Show child attributes

data.dataBytes.remaining

integer<int64>

required

The remaining data allowance in bytes.

Example:

1073741824

data.dataBytes.limit

integer<int64>

required

The total data allowance limit in bytes.

Example:

5368709120

data.topupBytes

object

Additional data purchased as top-ups.

Show child attributes

data.topupBytes.remaining

integer<int64>

required

The remaining data allowance in bytes.

Example:

1073741824

data.topupBytes.limit

integer<int64>

required

The total data allowance limit in bytes.

Example:

5368709120

data.ildTopup

object

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

Show child attributes

data.ildTopup.balance

number<double>

The remaining balance for international long distance calling top-ups.

Only applicable if the subscription plan includes ILD top-up capabilities.

Example:

15.5

data.ildTopup.currency

string

The currency of the ILD top-up balance.

Example:

"USD"

data.ildTopup.expiryDate

string<date>

The date when the international long distance calling top-up balance expires.

Only applicable if the subscription plan includes ILD top-up capabilities.

Example:

"2024-12-31"

data.hotspotDataBytes

object

Data usage specifically for hotspot/tethering functionality.

Only applicable if the subscription plan includes hotspot capabilities.

Show child attributes

data.hotspotDataBytes.remaining

integer<int64>

required

The remaining data allowance in bytes.

Example:

1073741824

data.hotspotDataBytes.limit

integer<int64>

required

The total data allowance limit in bytes.

Example:

5368709120

data.hotspotTopupBytes

object

Additional hotspot data purchased as top-ups.

Only applicable if the subscription plan includes hotspot capabilities.

Show child attributes

data.hotspotTopupBytes.remaining

integer<int64>

required

The remaining data allowance in bytes.

Example:

1073741824

data.hotspotTopupBytes.limit

integer<int64>

required

The total data allowance limit in bytes.

Example:

5368709120

Response

Acknowledged

Getting started

Overview

API reference

Authorizations

Body

Response