credits.low

Payload

Object: EventCreditsLow

• idstringrequired

  Event ID (evt_…), also sent as the webhook-id header. Use it to drop duplicate deliveries.

• typestringrequired

  Allowed values: credits.low

• created_atstring (date-time)required

  When the change happened (UTC).

• org_idintegerrequired
• api_versionstringrequired

  Contract version of the data schema.

• sequenceinteger

  Delivery sequence number within the endpoint (absent for a test event).

• objectWebhookEventObjectrequired
• payloadstringrequired

  thin means no data: read the object through the API.

  Allowed values: fullthin

• dataobject
  Fields

  • thresholdintegerrequired

    Threshold in percent of the allowance used: 80 or 100.

  • period_startstring (date)required
  • balancenumber
  • allowancenumber
• testbooleanrequired

  A test event sent by POST /v1/webhooks/{webhook_id}/test.

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "credits.low",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "org",
    "id": "1"
  },
  "payload": "full",
  "data": {
    "threshold": 80,
    "period_start": "2026-10-01",
    "balance": 1000,
    "allowance": 5000
  },
  "test": false
}