Skip to main content
Make sure to read the Webhooks Overview for important information about signature verification.

Purpose

The usage.threshold.exceeded.money webhook is triggered when what a customer owes for a usage brick reaches a set amount in the current billing period, e.g. $100 of usage this month. Configure the amounts on the brick under Usage alerts. See Usage Alerts for setup.

When it fires

  • The amount is the brick’s usage charge for the current billing period.
  • It fires once per threshold in each billing period. If one usage record crosses several thresholds, one event is sent for each threshold crossed.
  • Usage pools do not send it. Use usage.threshold.exceeded.precommitment for pools.
Only usage in the current billing period is checked. Backfilling usage for an earlier period does not send this webhook.

Payload format

Your configured endpoint will receive a Usage Threshold payload with alerting_target_type set to money.
alert_threshold_value and actual_usage_value are in the smallest unit of the order’s currency, e.g. cents for USD. "10000.00" is $100.00.