Event types
We send HTTPS notifications to your server as events occur so you can react immediately. Each event belongs to one of four types:- Subscription events: Lifecycle changes such as renewing, pausing, resuming. Find the full list below.
Subscription event example
Subscription event example
- Order events: Sent when a payment reaches the
Settledstatus. Optionally,Declinedevents can be sent (disabled by default).
Order event example
Order event example
-
Lifetime access / one-off purchase events: For one-time purchases, only two events are possible:
Granted— access grantedRevoked— access revoked
- Refund events: Sent when a refund is completed.
event_id. Use this ID for idempotency—if you’ve already processed an event with the same event_id, ignore the duplicate.
Subscription events
These events describe changes across the subscription lifecycle.| Event | Description |
|---|---|
STARTING_TRIAL | Start of the trial period |
CONVERTION | Conversion from trial to paid subscription |
RENEWING | Subscription renewal (regular charge) |
UNSUBSCRIPTION | User cancels subscription (auto-renewal turned off) |
PAUSING | Subscription is paused |
DEFERRING | Postponement of next charge date (deferred subscription) |
RESUMING | Resuming a paused subscription |
RECOVERING_AUTORENEW | Restoring auto-renewal after failure |
EXPIRATION | Subscription expiration |
UNKNOWN | Unknown or unclassified event |
START_GRACE | Start of grace period after a failed charge |
START_RETRY | Start of retry attempts without a grace period |
FINISH_GRACE | End of grace period |
RECOVERING | Recovery from grace/retry state |
