Skip to main content
WEBHOOK

Body

application/json
aggregation_type
enum<string>
required
Available options:
COUNT,
LATEST,
MAX,
MIN,
MEAN,
SUM,
COUNT_DISTINCT
code
string
required
created_at
string<date-time>
required
metric_id
string<MeteroidId>
required
Example:

"bm_7n42DGM5Tflk9n8mt7Fhc7"

name
string
required
product_family_id
string<MeteroidId>
required
Example:

"pf_7n42DGM5Tflk9n8mt7Fhc7"

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
aggregation_key
string | null
description
string | null
product_id
string<MeteroidId> | null
Example:

"prd_7n42DGM5Tflk9n8mt7Fhc7"

segmentation_matrix
object
unit_conversion_factor
integer<int32> | null
unit_conversion_rounding
enum<string> | null
Available options:
UP,
DOWN,
NEAREST,
NEAREST_HALF,
NEAREST_DECILE,
NONE
unit_plural
string | null

What several units of the metric are called, e.g. tokens.

unit_singular
string | null

What one unit of the metric is called, e.g. token.

usage_group_key
string | null

Response

200

Webhook received successfully