Skip to main content
WEBHOOK

Body

application/json

A spending cap stopped an automatic top-up.

​
attempted_amount
integer<int64>
required

What the suppressed top-up would have charged, tax included once it was quoted (before tax when the cap stopped it before then). Caps are always money: for a credit unit wallet, currency is the customer's currency.

​
cap
integer<int64>
required

The cap, tax included, in minor units of currency.

​
currency
string
required

The currency the cap and the charge are in (ISO 4217).

​
customer_id
string<MeteroidId>
required
Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

​
period
string
required

DAILY (rolling day) or MONTHLY (calendar month, UTC).

​
period_end
string<date-time>
required

End of the capped period.

​
period_start
string<date-time>
required

Start of the capped period.

​
id
string<MeteroidId>
required
Example:

"evt_7n42DGM5Tflk9n8mt7Fhc7"

​
timestamp
string<date-time>
required
​
type
enum<string>
required
Available options:
metric.created,
customer.created,
subscription.created,
subscription.updated,
subscription.cancelled,
subscription.ended,
invoice.created,
invoice.finalized,
invoice.paid,
invoice.voided,
invoice.closed,
invoice.consolidated,
invoice.deleted,
invoice.accounting_pdf_generated,
quote.accepted,
quote.converted,
credit_note.created,
credit_note.finalized,
credit_note.voided,
plan.created,
plan.published,
plan.archived,
product.created,
product.updated,
product.archived,
metric.updated,
metric.archived,
coupon.created,
coupon.updated,
coupon.archived,
addon.created,
addon.updated,
addon.archived,
refund.issued,
refund.settled,
refund.failed,
payment.reversed,
payment.reinstated,
payment.failed,
wallet.funded,
wallet.debited,
wallet.balance_low,
wallet.credit_unrecovered,
wallet.credit_recovered,
wallet.auto_top_up_failed,
wallet.auto_top_up_suspended,
wallet.auto_top_up_consent_changed,
wallet.depleted,
wallet.recovered,
wallet.auto_top_up_cap_reached,
credit_grant.expired,
entitlement.usage_threshold_reached,
entitlement.limit_reached,
budget.threshold_reached,
budget.exceeded,
entitlement.too_many_groups

Response

200

Webhook received successfully