Alerts

alerts.triggered
data.object
Sent when a new usage alert threshold has been crossed.Schema example

Credit notes and refunds

credit_note.created
data.object
Sent when a new credit note has been issued for a customer. This will allow your application to proceed with the refund.Schema example
credit_note.generated
data.object
Sent when the PDF file has been generated for a credit note. This will allow your application to retrieve the PDF credit note.Schema example
credit_note.refund_failure
data.object
Sent when there is an error related to the refund process (i.e. the payment provider cannot refund the customer).Schema example

Customers

Basic customer information

customer.created
data.object
Sent when a customer is successfully created in Lago.Schema example
customer.updated
data.object
Sent when a customer is successfully updated in Lago.Schema example
integration.provider_error
data.object
Sent when an error was encountered while processing data on an integrationSchema example

External payment providers

customer.payment_provider_created
data.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.Schema example
customer.payment_provider_error
data.object
Sent when there is an error related to the creation of a customer in the payment provider’s system.Schema example
customer.checkout_url_generated
data.object
Sent when a checkout link is issued for a customer.Schema example
customer.checkout_url_generated
data.object
Sent when a checkout link is issued for a customer.Schema example

External accounting providers

customer.accounting_provider_created
data.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.Schema example
customer.accounting_provider_error
data.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.Schema example

External CRM providers

customer.crm_provider_created
data.object
Sent when a customer has been created in the CRM provider.Schema example
customer.crm_provider_error
data.object
Sent when an error was encountered while syncing a customer to a CRM provider.Schema example

External tax providers

customer.tax_provider_error
data.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.Schema example
customer.vies_check
data.object
Sent when a VIES VAT number has been checked for a customerSchema example

Event ingestion

events.errors
data.object
Sent by the health check process when some events received in the previous hour do not match the validation rules.Schema example
events.error
data.object
deprecated
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.Schema example

Invoices

invoice.drafted
data.object
Sent when a new invoice is in draft.Schema example
invoice.created
data.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.Schema example
invoice.one_off_created
data.object
Sent when a one-off invoice is created. Only add-ons can be applied to one-off invoices.Schema example
invoice.paid_credit_added
data.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.Schema example
invoice.generated
data.object
Sent when the PDF file has been generated for a customer invoice. This will allow your application to retrieve the PDF invoice.Schema example
invoice.payment_status_updated
data.object
Sent when the payment status of an invoice is updated based on information provided by the payment provider.Schema example
invoice.payment_overdue
data.object
Sent when the payment of an invoice is considered as overdue.Schema example
invoice.voided
data.object
Sent when an invoice is voided.Schema example
invoice.payment_failure
data.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.Schema example
invoice.payment_dispute_lost
data.object
Sent whenever a dispute or a chargeback is lost within your payment provider.Schema example
invoice.resynced
data.object
Sent when an invoice has been resynced with salesforce.Schema example

Payments

payment.requires_action
data.object
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.Schema example
payment.requires_action
data.object
This message is triggered when a an error was raised by a payment provider.Schema example
payment_request.created
data.object
Sent when a manual payment request has been triggered, to request payment for the overdue balance.Schema example
payment_request.payment_failure
data.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.Schema example
payment_request.payment_status_updated
data.object
Sent when the payment attached to a payment request is updated to a new payment status, through the `payment_status field.Schema example

Payment receipts

payment_receipt.created
data.object
Payment receipt object. Sent when a payment receipt is created. This event serves as a signal to your application that the receipt creation is complete and the payment has been recorded.
payment_receipt.generated
data.object
Payment receipt object. Sent when the PDF file has been generated for a payment receipt. This will allow your application to retrieve the PDF receipt.

Plans

plan.created
data.object
Sent when a plan is created.Schema example
plan.updated
data.object
Sent when a plan is updated.Schema example
plan.deleted
data.object
Sent when a plan is deleted.Schema example

Subscriptions and fees

fee.created
data.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.Schema example
fee.tax_provider_error
data.object
Sent when an error was encountered while fetching taxes for a fee on a tax provider.Schema example
subscription.started
data.object
Sent when a subscription starts. The previous_plan_code argument is filled if the subscription has been upgraded or downgraded.Schema example
subscription.termination_alert
data.object
Alert for imminent termination of subscriptions with set end dates, sent 45 days and 15 days prior (at fixed intervals).Schema example
subscription.terminated
data.object
Sent when a subscription is terminated. The next_plan_code argument is filled if the subscription has been upgraded or downgraded.Schema example
subscription.trial_ended
data.object
Sent when the free trial is ended for a subscription.Schema example
subscription.usage_threshold_reached
data.object
Sent when a progressive billing threshold has been crossed.Schema example

Wallets and prepaid credits

wallet.created
data.object
Wallet object. Sent when a wallet is created.
wallet.updated
data.object
Wallet object. Sent when a wallet is updated. Please note that you won’t receive this message if the wallet’s ongoing balance is updated.
wallet.terminated
data.object
Wallet object. Sent when a wallet is terminated.
wallet.depleted_ongoing_balance
data.object
Sent when the ongoing balance is negative or equal to 0.Schema example
wallet_transaction.created
data.object
Sent when a wallet transaction is created. For example, when new credits have been paid or offered.Schema example
wallet_transaction.updated
data.object
Sent when a wallet transaction is updated. For example, when wallet transaction is marked as settled.Schema example
wallet_transaction.payment_failure
data.object
Sent when a wallet transaction payment is declined.Schema example