Sign in

v1

latestOpenAPI 3.1.0AGPL-3.0-only2026-07-1773264353.7 KB
webhooks

metric.archived webhook

A billable metric was archived

postWebhookmetric.archived

Payload

aggregation_keystring nullable
aggregation_type'COUNT' | 'LATEST' | 'MAX' | 'MIN' | 'MEAN' | 'SUM' | 'COUNT_DISTINCT' required
codestring required
created_atstring date-time required
descriptionstring nullable
metric_idstring MeteroidId required
namestring required
product_family_idstring MeteroidId required
product_idstring MeteroidId
unit_conversion_factorinteger nullable
unit_conversion_rounding'UP' | 'DOWN' | 'NEAREST' | 'NEAREST_HALF' | 'NEAREST_DECILE' | 'NONE'
usage_group_keystring nullable
idstring MeteroidId required
timestampstring date-time required
type'metric.created' | 'customer.created' | 'subscription.created' | 'invoice.created' | 'invoice.finalized' | 'invoice.paid' | 'invoice.voided' | 'invoice.consolidated' | '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' required

Example payload

{
  "metric_id": "bm_7n42DGM5Tflk9n8mt7Fhc7",
  "product_family_id": "pf_7n42DGM5Tflk9n8mt7Fhc7",
  "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7",
  "id": "evt_7n42DGM5Tflk9n8mt7Fhc7"
}

Response

Webhook received successfully