Types of Webhook Events
This table summarizes some of the event types you may receive through your webhook endpoint.
Event enum value | Description |
---|---|
PlanCreated | An event has been triggered to notify that a new plan has been created. |
CustomerPaymentSucceeded | An event has been triggered to notify that a payment towards a customer's plan has been successfully processed. |
PlanLate | An event has been triggered to notify that a payment for a plan has been missed, causing the plan to become overdue. |
PlanCompleted | An event has been triggered to notify that all required payments for a plan have been successfully processed. |
PlanCancelled | An event has been triggered to notify that a plan has been canceled. |
ItemAdded | An event has been triggered to notify that an item has been added to a plan. |
ItemRemoved | An event has been triggered to notify that an item has been removed from a plan. |
Lifecycle of a Plan
The events described above affect the plan status. This is a state diagram of the possible transitions that may occur.