Sign in

v1

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

plan.archived webhook

A plan was archived

postWebhookplan.archived

Payload

created_atstring date-time required
currencystring required
descriptionstring nullable
namestring required
plan_idstring MeteroidId required
plan_type'STANDARD' | 'FREE' | 'CUSTOM' required
status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED' required
versioninteger 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

{
  "plan_id": "plan_7n42DGM5Tflk9n8mt7Fhc7",
  "id": "evt_7n42DGM5Tflk9n8mt7Fhc7"
}

Response

Webhook received successfully