Skip to content

Data allowance consumed
Webhook

Request

Triggered when 50%, 80%, or 100% of a fixed validity plan's data allowance is consumed (no events for recurring plans).

Security
ApiKeyAuth
Bodyapplication/json
typestringrequired
Example:"attachment.allowanceConsumed"
timestampintegerrequired

Unix timestamp when the event was fired

Example:1730474606
dataobjectrequired
POST
attachment.allowanceConsumed
Payload
{
  "type": "attachment.allowanceConsumed",
  "timestamp": 1730474606,
  "data": {
    "usagePercentage": 80,
    "dataUsageBytes": 1231230,
    "esim": "8937103400004164763",
    "planId": "33de44b0-5103-45ea-9723-0a7aa104c76a",
    "attachmentId": "a1ac5a45-e05b-4728-9253-17c54fc1c5ff"
  }
}

Responses

Return a 200 status to indicate that the data was received successfully