Skip to main content
WEBHOOK

Body

application/json

Sent when a subscription changes state. Subtypes describe changes across the subscription lifecycle:

  • STARTING_TRIAL - Trial period starts
  • CONVERTION - Trial converts to paid subscription
  • RENEWING - Subscription renews (regular charge)
  • UNSUBSCRIPTION - User cancels subscription (auto-renewal disabled)
  • PLANNING_POSTPONED_SUBSCRIPTION - Subscription with UPCOMING status scheduled to start when delayed_start migration is used
  • PAUSING - Subscription paused
  • DEFERRING - Next charge date postponed
  • RESUMING - Paused subscription resumes
  • RECOVERING_AUTORENEW - Auto-renewal restored after failure
  • EXPIRATION - Subscription expired
  • UNKNOWN - Unknown or unclassified event
  • START_GRACE - Grace period starts after failed charge
  • START_RETRY - Retry attempts start without grace period
  • FINISH_GRACE - Grace period ends
  • RECOVERING - Recovered from grace/retry state
event_type
enum<string>
required
Available options:
subscription,
oneoff,
order,
refund,
user,
dispute
event_id
string<uuid>
required
event_timestamp
string<date-time>
required
is_livemode
boolean
required
subtype
enum<string>
required
Available options:
starting_trial,
convertion,
renewing,
unsubscription,
planning_postponed_subscription,
pausing,
defering,
resuming,
recovering_autorenew,
expiration,
unknown,
start_grace,
start_retry,
finish_grace,
recovering
external_id
string
required
subscription
object
required
user
object
required
order
object | null