Event Types

Event Name	Event Type	Trigger Condition	Data Structure	Description
Trial period expiring soon	subscription.trial_period_expiring	When the trial expires in 3 days (single reminder)	Subscription	It's triggered when a customer's subscription trial period is due to expire in 3 days. It is sent only once per subscription. Use Case Expiry reminder: Send a trial expiry reminder to the customer.
First subscription activated	subscription.first	When a subscription is activated for the first time	Subscription	It is triggered when a subscription enters the trial or active state for the first time. It is sent only once per subscription. Use Case Subscription confirmation: To notify the customer of their successful initial subscription (e.g., via push notification or email). Features granting: To unlock the service permissions associated with the customer's subscription (e.g., premium features, resource quotas).
Subscription canceled	subscription.canceled	When a subscription is actively canceled	Subscription	It is triggered when a subscription is effectively terminated. Use Case Service termination notice: To inform the customer that their subscription has ended, specifying the exact time when service will cease. Features revocation: To revoke the user's paid access and features.
Subscription changed	subscription.price_changed	when a subscription is upgraded or downgraded.	Subscription	It is triggered when a subscription's price changes, providing the specific details of the change.
Invoice paid successfully	invoice.paid	When an invoice is paid successfully	Invoice	It is sent upon successful payment for a one-time purchase or a subscription-related charge. It is used to synchronize invoice status and manage subscriptions. Use Case Invoice status synchronization: To update the invoice status to "completed". Subscription management: For renewal invoices, this event contains subscription cycle details, such as the current cycle number and cycle timeframe.
Invoice payment failed	invoice.payment_failed	When an attempt to pay an invoice fails	Invoice	It is sent when a payment for a one-time purchase or a subscription-related charge ultimately fails. It is not sent for every retry attempt, only upon the final payment failure. Use Case Failure notification and payment retry guidance: To alert the customer of the payment failure and provide a means to re-attempt payment.
Trade order payment succeeded	trades.succeeded	When a trade order is paid successfully	Trade	It is sent for any successful payment type and is suitable for closed-loop scenarios involving simple monetary transactions.
Refund succeeded	refunds.succeeded	When a refund is processed successfully	Refund	This event is triggered when a refund has been successfully processed and finalized Use Case Refund notification and status synchronization: To inform the user of the refunded amount and update the refund status to "completed".
Refund failed	refunds.failed	When an attempt to process a refund fails	Refund	This event is triggered when a refund attempt fails. Use Case Status synchronization: To update the refund status to "failed". Retry mechanism and manual intervention: To trigger an automatic retry process or alert customer support for manual investigation, enabling a timely re-initiation of the refund to prevent customer complaints and financial disputes.