| Event | Trigger |
|---|---|
| Invoice Payment (payment received) | A payment made against a particular Invoice—either through a scheduled batch payment or the result of a makePayment(), modify() or cancel()call.Message Content: The Transaction object of the payment that triggered the Push: the InvoiceID. |
| Status Changed | A change in invoice status (including when the invoice is created).Message Content: invoice |
| Pre-notification (Push 2.0) | A pre-notification for subscription renewal sent a specified number of days before the renewal, based on the Billing Plan’s billing_notification_days attribute. The Push Notification includes the Invoice object and provides info as to when billing will happen and the billing amount.Message Content: invoice |
| End of Trial (Push 2.0) | A notification about the free trial period completion and the commencement of upcoming paid period. A notification is sent a specified number of days before the free trial completion, based on the Billing Plan’s trial_end_notification_days if the Subscription’s attribute notify_on_transition is set to true. Message Content: invoice |
| Parent topic:Push Event Classes and Events |
Event Class: Invoices
Invoices Push Notifications inform you when key events occur for an Invoice, such as when a payment is recorded.
The Invoice Class currently includes the following events: