Adds amount paid off Stripe property to Invoice object
What’s new
Adds the amount_paid_off_stripe property to the Invoice object. This integer property represents the total amount, in the invoice’s currency, that was paid on the invoice outside of Stripe (out of band). The property supports both full and partial out-of-band payments and is dynamically computed from Payment Record data where the payment processor isn’t Stripe.
You can include this property in API requests (for example, retrieving an invoice). The property isn’t available in event payloads or Sigma.
Command Line
Select a language
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
Impact
You can now track payments made outside of Stripe directly on the Invoice object, making it easier to perform accounting reconciliation for off-Stripe payments. This replaces the need to rely on the deprecated paid_out_of_band boolean property, which only indicated whether any out-of-band payment occurred but didn’t specify the amount.
If you previously used the paid_out_of_band property for reconciliation purposes, you can now use amount_paid_off_stripe to get more precise information about the actual amounts paid outside of Stripe.
Changes
| Parameter | Change | Resources or endpoints |
|---|---|---|
| amount_paid_off_stripe | Added | Invoice |
Upgrade
- View your current API version in Workbench.
- If you use an SDK, upgrade to the corresponding SDK version for this API version.
- If you don’t use an SDK, update your API requests to include Stripe-Version: 2026-05-27. dahlia
- Upgrade the API version used for webhook endpoints .
- Test your integration against the new version.
- If you use Connect, test your Connect integration .
Learn more about Stripe API upgrades.
Related changes
- Adds discount eligibility options for add-on invoice items on Subscriptions and Preview Invoice APIs
- Adds billing schedules to enable prebilling on subscriptions
- Adds discount and discounts properties to pending subscription updates
- Adds metadata support to pending subscription updates
- Adds credited items information to invoice item proration details
- Adds customer parameter to test clock creation