Types of events
Learn more about the available types of events you can subscribe to using webhooks.
The event types follow a pattern: <resource>.<event>. We aim to be consistent, making things easier and more organized.
Below is a list of all the available types of events PayRex sends through webhooks. We may add more anytime as our platform changes, so do not assume that only these types exist.
billing_statement.created data.resource is a Billing Statement
Occurs when a Billing Statement has been created.
billing_statement.updated data.resource is a Billing Statement
Occurs when a Billing Statement has been updated. For example, if the due date has been updated.
billing_statement.deleted data.resource is a Billing Statement
Occurs when a Billing Statement has been deleted.
billing_statement.finalized data.resource is a Billing Statement
Occurs when a Billing Statement has been finalized.
billing_statement.sent data.resource is a Billing Statement
Occurs when a Billing Statement has been sent to the customer.
billing_statement.marked_uncollectible data.resource is a Billing Statement
Occurs when a Billing Statement has been marked as uncollectible.
billing_statement.voided data.resource is a Billing Statement
Occurs when a Billing Statement has been marked as voided.
billing_statement.paid data.resource is a Billing Statement
Occurs when a Billing Statement has been paid by the customer.
billing_statement.will_be_due data.resource is a Billing Statement
Occurs 5 number of days before a billing statement becomes due.
billing_statement.overdue data.resource is a Billing Statement
Occurs 5 number of days after a billing statement becomes due.
billing_statement_line_item.created data.resource is a Billing Statement Line Item
Occurs when a Billing Statement Line Item is created.
billing_statement_line_item.updated data.resource is a Billing Statement Line Item
Occurs when a Billing Statement Line Item is updated.
billing_statement_line_item.deleted data.resource is a Billing Statement Line Item
Occurs when a Billing Statement Line Item is deleted.
checkout_session.expired data.resource is a Checkout Session
Occurs when a Checkout Session expires.
payment_intent.awaiting_capture data.resource is a Checkout Session
Occurs when a Payment Intent can be captured. This event is applicable for hold then capture feature for card payments.
payment_intent.succeeded data.resource is a Payment Intent
Occurs when the Payment Intent has successfully completed a payment. Another notable change is the Payment Intent status transitions to succeeded.
payout.deposited data.resource is a Payout
Occurs when a Payout transfer to your bank account is successful. Another notable change is the Payout status transitions to successful.
refund.created data.resource is a Refund
Occurs when a Payment is refunded, either partial or full amount. To determine the final status of a refund, best to use refund.updated event.
refund.updated data.resource is a Refund
Occurs when a Refund is updated, either partial or full amount. This event holds the final status of a refund.