Skip to main content
WEBHOOK
credits.automatic_recharge_limit_exceeded
{
  "type": "credits.automatic_recharge_limit_exceeded",
  "configId": "config-uuid-123",
  "customerId": "customer-demo-01",
  "currencyId": "tokens",
  "maxSpendLimit": 250,
  "totalSpent": 225,
  "percentageUsed": 90,
  "threshold": 90
}

Body

application/json

Emitted when the monthly auto-recharge spend limit is approached or exceeded. Threshold values:

  • 80 — Approaching limit warning
  • 90 — Near limit warning
  • 100 — Limit exceeded
type
string
required

Event type discriminator.

Allowed value: "credits.automatic_recharge_limit_exceeded"
configId
string
required

Identifier of the auto-recharge configuration.

customerId
string
required

External/customer-facing identifier.

currencyId
string
required

Currency/credit type identifier.

maxSpendLimit
number
required

Configured maximum monthly spend limit.

totalSpent
number
required

Total amount spent this month on automatic recharges.

percentageUsed
number
required

Percentage of the spend limit used (0–100).

threshold
enum<number>
required

Threshold that was crossed (80, 90, or 100).

Available options:
80,
90,
100