v1

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

coupon.archived webhook

A coupon was archived

postWebhookcoupon.archived

Payload

codestring required
coupon_idstring MeteroidId required
created_atstring date-time required
descriptionstring required
disabledboolean required
expires_atstring date-time nullable
recurring_valueinteger nullable
redemption_limitinteger nullable
reusableboolean required
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

{
  "coupon_id": "cou_7n42DGM5Tflk9n8mt7Fhc7",
  "id": "evt_7n42DGM5Tflk9n8mt7Fhc7"
}

Response

Webhook received successfully