Messages
Below is a list of the event types we currently send. Please note that additional event types may be introduced in the future, so your code should be flexible enough to accommodate new types as they arise. Our objective is to maintain a consistent and predictable event structure, making it easier to integrate and handle messages, along with the objects they affect.
Credit notes and refunds
Credit note object. Sent when a new credit note has been issued for a customer. This will allow your application to proceed with the refund.
Credit note object. Sent when the PDF file has been generated for a credit note. This will allow your application to retrieve the PDF credit note.
credit_note_payment_provider_refund_error object. Sent when there is an error related to the refund process (i.e. the payment provider cannot refund the customer).
Customers
External payment providers
Customer object. Sent when a customer is successfully created in the payment provider’s application. This allows you to retrieve the identifier assigned to the customer by the payment service provider.
payment_provider_customer_checkout_url object. Sent when a checkout link is issued for a customer.
payment_provider_customer_error object. Sent when there is an error related to the creation of a customer in the payment provider’s system.
payment_provider_invoice_payment_error object. Sent when there is an error related to the payment process. Usually occurs when no valid payment method is defined for the customer in the payment service provider’s application.
payment_dispute_lost object. Sent whenever a dispute or a chargeback is lost within your payment provider.
External accounting providers
Customer object. Sent when a customer is successfully created in the accounting provider’s application (like NetSuite). This allows you to retrieve the identifier assigned to the customer by the accounting service provider.
accounting_provider_customer_error object. Sent when there is an error related to the accounting provider sync. Usually occurs when something went wrong in the accounting service provider’s application.
External tax providers
tax_provider_error object. Sent when there is an error related to the tax provider sync. This usually occurs due to issues with item mappings, customer definitions, or within the service provider’s application.
Event ingestion
Sent by the health check process when some events received in the previous hour do not match the validation rules.
This webhook is deprecated and no longer sent in Lago v0.50.0-beta and above. It was sent when there was an error related to the creation of an event.
Invoices
Invoice object. Sent when a new invoice is in draft.
Invoice object. Sent when an invoice is finalized. This event serves as a signal to your application that the invoice processing is complete and you can proceed with the necessary billing actions or procedures.
Invoice object. Sent when a one-off invoice is created. Only add-ons can be applied to one-off invoices.
Invoice object. Sent when prepaid credits have been paid and added to the customer’s wallet. You can use this information to generate a PDF invoice or collect the payment.
Invoice object. Sent when the PDF file has been generated for a customer invoice. This will allow your application to retrieve the PDF invoice.
Invoice object. Sent when the payment status of an invoice is updated based on information provided by the payment provider.
Invoice object. Sent when the payment of an invoice is considered as overdue.
Invoice object. Sent when an invoice is voided.
Payments
This message is triggered when a payment requires additional validation or confirmation, typically via 3D Secure (3DS). This is commonly seen in regions like India or when enhanced customer authentication is necessary.
The url field contains the checkout link that initiates 3D Secure (3DS) validation for your customers. The return_url is the page displayed once the 3DS process is completed.
Payment request object. Sent when a manual payment request has been triggered, to request payment for the overdue balance.
Payment request object. Sent when the payment attached to a payment request has failed. The provider_error field indicates the error code and message from the payment provider.
Payment request object. Sent when the payment attached to a payment request is updated to a new payment status, through the `payment_status field.
Subscriptions and fees
Fee object. Sent when a fee for a charge to be paid in advance is created. You can use this information to collect the payment of the pay_in_advance fee. Useful for fintech companies that need to create a statement of transactions without invoicing.
Subscription object. Sent when a subscription starts.
Subscription object. Alert for imminent termination of subscriptions with set end dates, sent 45 days and 15 days prior (at fixed intervals).
Subscription object. Sent when a subscription is terminated.
Subscription object. Sent when the free trial is ended for a subscription.
Subscription object. Sent when a progressive billing threshold has been crossed.
Wallets and prepaid credits
Wallet transaction object. Sent when a wallet transaction is updated. For example, when wallet transaction is marked as settled.
Wallet object. Sent when the ongoing balance is negative or equal to 0.
Was this page helpful?