Skip to main content
WEBHOOK

Body

application/json

An automatic top-up charge failed, or the automatic top-up was suspended.

​
amount
integer<int64>
required

The charge in minor units of currency: the credit it would have added, or for a credit unit wallet the price of those credits in the customer's currency. When the credits could not be priced (no selling price), the credits themselves, with currency the unit code. On a suspension after a top-up payment was refunded or disputed: that payment's top-up.

​
consecutive_failures
integer<int32>
required

Failed charges in a row, this one included.

​
currency
string
required

The currency charged (ISO 4217), or the credit unit code when the credits had no price.

​
customer_id
string<MeteroidId>
required
Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

​
error
string
required

May carry payment provider detail.

​
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
​
suspended_at
string<date-time> | null

Set on wallet.auto_top_up_suspended: when it was suspended.

Response

200

Webhook received successfully