Skip to main content
WEBHOOK
subscription.quotaNotification
{
  "eventId": "b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab",
  "type": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "data": {
    "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"
  }
}

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. Event-specific payload; structure depends on event type.

Response

Acknowledged

⌘I