docs(webhooks): document invoice.ready_to_finalize webhook - #565
Merged
Conversation
annvelents
approved these changes
Aug 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documents the
invoice.ready_to_finalizewebhook, which exists in lago-api (Webhooks::Invoices::ReadyToFinalizeService) but was missing from the OpenAPI spec.This event signals that a draft invoice is ready to be finalized (taxes are resolved). It fires either when the draft is created and no tax provider call is pending (
Invoices::SubscriptionService), or once the tax provider returns taxes for the draft invoice (Invoices::ProviderTaxes::PullTaxesAndApplyService).The payload uses the same serializer includes as
invoice.drafted(customer, subscriptions, billing_periods, fees, credits, applied_taxes, error_details), so the spec references the sameInvoiceObjectExtendedschema.Changes
src/webhooks/invoice_ready_to_finalize.yaml(modeled oninvoice_drafted.yaml)src/openapi.yamlwebhooks sectionopenapi.yamlnpm run test(redocly bundle + redocly lint + spectral lint) passes with no new warnings.