credits.low_balance
⚠️
Preview — this feature is being built; the design below is the spec.
Sent when: The credit balance fell below the auto-reload trigger and no reload happened (auto-reload off or the payment failed).
| Property | Value |
|---|---|
| Scope | The whole organization. Register with an Admin key at /v1/organizations/webhooks. |
| Area | Billing |
| Subscribe with | "events": ["credits.low_balance"], or a prefix such as "credits.*" |
Payload
{
"id": "evt_01JCA5D7F9H1K3M5P7R9",
"type": "credits.low_balance",
"created_at": "2026-11-05T10:00:00Z",
"organization_id": "org_01J9X8Z6B4D2F0H8K6M4",
"data": {
"object": {
"type": "credit_balance",
"balance_usd": "8.40",
"trigger_usd": "20.00",
"auto_reload": {
"enabled": true,
"last_attempt": "failed"
}
}
}
}data.object matches what the corresponding GET endpoint returned when the event happened. Prompt and output text are never included.
What to do
- Fix the payment method or top up; credit-paid requests stop at zero.
Delivery
Deliveries are signed, retried with back-off for up to 3 days, and may arrive more than once or out of order. De-duplicate on the syntic-event-id header and compare timestamps before acting. See Webhooks.
Was this page helpful?