Skip to main content
WEBHOOK

Body

application/json
​
as_of
string<date-time>
required
​
customer_id
string<MeteroidId>
required
Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

​
exact
boolean
required

Always false: usage is aggregated asynchronously and may lag the latest events.

​
feature_id
string<MeteroidId>
required
Example:

"feat_7n42DGM5Tflk9n8mt7Fhc7"

​
limit
string<decimal>
required
​
metric_code
string
required
​
period
object
required

The period an alert was measured over; end is absent for a period that never ends.

​
threshold_pct
integer<int32>
required

Percentage of the limit the notification is for; 100 is the limit itself. Several levels crossed at once are sent in ascending order, but delivery order is not guaranteed (retries): rely on this field, not on arrival order.

Required range: x >= 0
​
used
string<decimal>
required
​
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
​
customer_alias
string | null
​
group
object | null

Dimension values of the group that crossed, when the metric is grouped.

​
subscription_id
string | null

Absent for a customer without an active subscription.

Response

200

Webhook received successfully