Adds credited items information to invoice item proration details
What’s new
Adds the credited_items property to the proration_details hash on the Invoice Item object. For credit invoice items that are prorations, this property provides links to the corresponding debit invoice line items or invoice items that the credit applies to.
The credited_items property contains:
- A type field indicating whether the credit references a pending invoice item ( invoice _ item ) or invoice line items on an existing invoice ( invoice _ line _ items )
- When type is invoice _ item , an invoice _ item field with the ID of the debited invoice item
- When type is invoice _ line _ items , an invoice _ line _ item _ details object containing information about the credited line items
Impact
You can now access detailed information about which debits a credit proration applies to, making it easier to reconcile prorations and understand the relationship between credit and debit items in your billing workflows. For more information on credit prorations with credited_items, see Relating credit prorations to debited items.
The credited_items property is read-only. Stripe automatically populates it when credit invoice items are created through the proration process.
Changes
| Parameter | Change | Resources or endpoints |
|---|---|---|
| credited_items | Added | InvoiceItem. proration_details |
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 .
- In Workbench, perform the upgrade . You can roll back the version for 72 hours.
Learn more about Stripe API upgrades.
Related changes
- Adds discount eligibility options for add-on invoice items on Subscriptions and Preview Invoice APIs
- Adds amount paid off Stripe property to Invoice object
- 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 customer parameter to test clock creation