Public preview
Additional properties on PaymentRecord and PaymentAttemptRecord Public preview
What’s new
Makes the following changes to the PaymentAttemptRecord and PaymentRecord resources:
- Adds support for storing and reading amounts using the new amount , amount _ authorized , and amount _ refunded properties.
- Adds support for storing and reading processor details using the new processor _ details property.
- Removes support for storing and reading a top-level payment reference by removing the payment _ reference property. This is replaced by processor _ details. custom. payment _ reference .
Impact
Preview users of the Payment Records API can now use the following properties of the PaymentAttemptRecord and PaymentRecord resources:
- amount
- amount _ authorized
- amount _ refunded
- processor _ details
Preview users of the Payment Records API can now use the processor_details parameter on the report_payment method.
Preview users of the Payment Records API can no longer use the top-level payment_reference property of the PaymentAttemptRecord and PaymentRecord resources. However, you can still use it with the payment_records_beta=v1 header.
Changes
| Parameters | Change | Resources or endpoints |
|---|---|---|
| amount amount_authorized amount_refunded application | Added | PaymentAttemptRecord PaymentRecord |
| processor_details | Added | PaymentAttemptRecord PaymentRecord PaymentRecord#report_payment |
| payment_reference | Removed | PaymentAttemptRecord PaymentRecord PaymentRecord#report_payment |
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: 2025-08-27. preview
- Upgrade the API version used for webhook endpoints .
- Test your integration against the new version.
- If you use Connect, test your Connect integration .
- In Workbench, perform the upgrade . You can roll back the version for 72 hours.
Learn more about Stripe API upgrades.