Webhook Notifications for Invoicing

Webhooks are automated notifications generated by system events that occur in your organization. You can create a webhook subscription for invoicing events to receive a notification when an invoice is:
  • Cancelled
  • Five-day early reminder
  • Fully paid
  • Overdue reminder
  • Partially paid
  • Sent
You must have a URL for the webhook notifications to be sent to.
Notifications that contain sensitive, personally identifiable information (PII), such as account numbers, are sent using message-level encryption. Transport Layer Security is required in order to ensure data integrity.
There are additional requirements for implementing webhooks that are not discussed in this guide. To create to webhook subscription to receive invoicing related notifications, see the
Webhooks Implementation Guide for the REST API
.

Invoicing Product ID and Event Types

When you send a
create a webhook subscription
request, set the
products.productId
field to
customerInvoicing
and set the
products.eventTypes
field to one or more of the values listed in the Event Type Field Value column in the table below. If you include multiple event types in your request, separate each event type field value with the comma character (
,
).
Invoicing Webhook Product ID and Event Types
Product ID
Event Type Field Value
Description
customerInvoicing
invoicing.customer.invoice.cancel
Merchants can subscribe to this event type to automate how their system is informed when an invoice is cancelled.
invoicing.customer.invoice.overdue-reminder
Notifies you 1 day after the invoice payment is due.
This event is triggered if you have invoice reminders enabled in your invoice settings.
invoicing.customer.invoice.paid
Merchants can subscribe to this event type to automate how their system is informed when an invoice is fully paid.
invoicing.customer.invoice.partial-payment
Merchants can subscribe to this event type to automate how their system is informed when an invoice is partially paid.
invoicing.customer.invoice.reminder
Notifies you 5 days before the invoice payment is due.
This event is triggered if you have invoice reminders enabled in your invoice settings.
invoicing.customer.invoice.send
Merchants can subscribe to this event type to automate how their system is informed when an invoice is sent to the customer.