Adds metadata property to credit note line items
What’s new
Adds the ability to attach key-value pairs to individual line items using the new metadata property of the Credit Note Line Item object.
When you create or preview a credit note, you can now specify metadata for each line item in the lines parameter. The API stores this metadata as part of the resulting Credit Note Line Item object and returns it when you retrieve the credit note or its line items.
The metadata property can contain up to 50 keys, with key names of up to 40 characters and values of up to 500 characters.
Impact
You can now attach custom information to individual credit note line items for internal tracking, reporting, and business logic. For example, you can use metadata to store internal product codes, department information, or other business-specific data that helps you categorise and analyse credit note line items.
Changes
| Parameter | Change | Resources or endpoints |
|---|---|---|
| metadata | Added | CreditNote#create. lines[] CreditNote#preview. lines[] CreditNote#preview_lines. lines[] + 1 more CreditNoteLineItem |
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-03-25. 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.