Ledger API 2026-06-15

This is a release-history archive topic. For current integration guidance, see the Ledger API package page.

Changes in 2026-06-15

New Features

• Payment success event: The payment.succeeded webhook reports when a payment reaches succeeded. A payment that did not complete its invoice previously produced no event when it succeeded, so the only way to learn the outcome was to retrieve the payment.
• Void reason: Invoice.void_reason returns the reason supplied to voidInvoice. The reason was previously stored but never returned, so an audit could not read it back through the API.

Compatibility

The changes in this release reach every pinned release. No change to Ledger-Version is needed.

Invoice.amount_due is deprecated. It is superseded by Invoice.amount_remaining, which has carried the same value since the initial release; two names for one value left integrators asking which to trust. amount_due continues to be populated in every release up to and including the first dated release after 2027-06-15, and is then removed. Replace each read of amount_due with amount_remaining before that release.