# Adds support for invoice items metadata and period in subscriptions and schedules ## What’s new We introduced a new way to customize the `metadata` and `period` fields for [one-off invoice items](https://docs.stripe.com/api/invoiceitems.md?api-version=2025-08-27.basil) generated by [subscriptions](https://docs.stripe.com/api/subscriptions.md?api-version=2025-08-27.basil) and [subscription schedules](https://docs.stripe.com/api/subscription_schedules.md?api-version=2025-08-27.basil):. - You can directly attach `metadata` when configuring `add_invoice_items`, eliminating the need to add this information later in subsequent and separate API calls. - You can specify custom `period.start` and `period.end` dates that override the default subscription billing cycle dates. This gives you precise control over revenue recognition periods for one-off charges. We’ve also included timestamp indicators (such as `max_item_period_start` and `min_item_period_end` for subscriptions, `phase_start` and `phase_end` for schedules). This helps you align dates to important timestamps such as subscription billing periods or subscription schedule phase dates. ## Impact Specify the `metadata` or the `period` field for `add_invoice_items` using the following API endpoints: - [Create](https://docs.stripe.com/api/subscriptions/create.md?api-version=2025-08-27.basil) or [Update](https://docs.stripe.com/api/subscriptions/update.md?api-version=2025-08-27.basil) subscriptions. - [Create](https://docs.stripe.com/api/subscription_schedules/create.md?api-version=2025-08-27.basil) or [Update](https://docs.stripe.com/api/subscription_schedules/update.md?api-version=2025-08-27.basil) schedules. - [Create](https://docs.stripe.com/api/invoices/create_preview.md?api-version=2025-08-27.basil) a preview invoice by specifying the `schedule_details`. ## Changes #### REST API | Parameters | Change | Resources or endpoints | | -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `metadata`, `period` | Added | [Invoice#create_preview.schedule_details.phases[].add_invoice_items[]](/api/invoices/create_preview?api-version=2025-08-27.basil#create_create_preview-schedule_details-phases-add_invoice_items), [Subscription#create.add_invoice_items[]](/api/subscriptions/create?api-version=2025-08-27.basil#create_subscription-add_invoice_items), [Subscription#update.add_invoice_items[]](/api/subscriptions/update?api-version=2025-08-27.basil#update_subscription-add_invoice_items), [SubscriptionSchedule.phases[].add_invoice_items[]](/api/subscription_schedules/object?api-version=2025-08-27.basil#subscription_schedule_object-phases-add_invoice_items), [SubscriptionSchedule#create.phases[].add_invoice_items[]](/api/subscription_schedules/create?api-version=2025-08-27.basil#create_subscription_schedule-phases-add_invoice_items), [SubscriptionSchedule#update.phases[].add_invoice_items[]](/api/subscription_schedules/update?api-version=2025-08-27.basil#update_subscription_schedule-phases-add_invoice_items) | #### Ruby | Parameters | Change | Resources or methods | | -------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `metadata`, `period` | Added | [Invoice::CreatePreviewParams::ScheduleDetail::Phase::AddInvoiceItem](/api/invoices/create_preview?api-version=2025-08-27.basil#create_create_preview-schedule_details-phases-add_invoice_items), [Subscription::CreateParams::AddInvoiceItem](/api/subscriptions/create?api-version=2025-08-27.basil#create_subscription-add_invoice_items), [Subscription::UpdateParams::AddInvoiceItem](/api/subscriptions/update?api-version=2025-08-27.basil#update_subscription-add_invoice_items), [SubscriptionSchedule::Phase::AddInvoiceItem](/api/subscription_schedules/object?api-version=2025-08-27.basil#subscription_schedule_object-phases-add_invoice_items), [SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem](/api/subscription_schedules/create?api-version=2025-08-27.basil#create_subscription_schedule-phases-add_invoice_items), [SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem](/api/subscription_schedules/update?api-version=2025-08-27.basil#update_subscription_schedule-phases-add_invoice_items) | #### Python | Parameters | Change | Resources or methods | | -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `metadata`, `period` | Added | [Invoice.CreatePreviewParamsScheduleDetailPhaseAddInvoiceItem](/api/invoices/create_preview?api-version=2025-08-27.basil#create_create_preview-schedule_details-phases-add_invoice_items), [Subscription.CreateParamsAddInvoiceItem](/api/subscriptions/create?api-version=2025-08-27.basil#create_subscription-add_invoice_items), [Subscription.ModifyParamsAddInvoiceItem](/api/subscriptions/update?api-version=2025-08-27.basil#update_subscription-add_invoice_items), [SubscriptionSchedule.Phase.AddInvoiceItem](/api/subscription_schedules/object?api-version=2025-08-27.basil#subscription_schedule_object-phases-add_invoice_items), [SubscriptionSchedule.CreateParamsPhaseAddInvoiceItem](/api/subscription_schedules/create?api-version=2025-08-27.basil#create_subscription_schedule-phases-add_invoice_items), [SubscriptionSchedule.ModifyParamsPhaseAddInvoiceItem](/api/subscription_schedules/update?api-version=2025-08-27.basil#update_subscription_schedule-phases-add_invoice_items) | #### PHP This change does not affect the PHP SDK. #### Java | Parameters | Change | Resources or methods | | -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `metadata`, `period` | Added | [InvoiceCreatePreviewParams.schedule_details.phases[].add_invoice_items[]](/api/invoices/create_preview?api-version=2025-08-27.basil#create_create_preview-schedule_details-phases-add_invoice_items), [SubscriptionCreateParams.add_invoice_items[]](/api/subscriptions/create?api-version=2025-08-27.basil#create_subscription-add_invoice_items), [SubscriptionUpdateParams.add_invoice_items[]](/api/subscriptions/update?api-version=2025-08-27.basil#update_subscription-add_invoice_items), [SubscriptionSchedule.phases[].add_invoice_items[]](/api/subscription_schedules/object?api-version=2025-08-27.basil#subscription_schedule_object-phases-add_invoice_items), [SubscriptionScheduleCreateParams.phases[].add_invoice_items[]](/api/subscription_schedules/create?api-version=2025-08-27.basil#create_subscription_schedule-phases-add_invoice_items), [SubscriptionScheduleUpdateParams.phases[].add_invoice_items[]](/api/subscription_schedules/update?api-version=2025-08-27.basil#update_subscription_schedule-phases-add_invoice_items) | #### Node.js | Parameters | Change | Resources or methods | | -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `metadata`, `period` | Added | [InvoiceCreatePreviewParams.schedule_details.phases[].add_invoice_items[]](/api/invoices/create_preview?api-version=2025-08-27.basil#create_create_preview-schedule_details-phases-add_invoice_items), [SubscriptionCreateParams.add_invoice_items[]](/api/subscriptions/create?api-version=2025-08-27.basil#create_subscription-add_invoice_items), [SubscriptionUpdateParams.add_invoice_items[]](/api/subscriptions/update?api-version=2025-08-27.basil#update_subscription-add_invoice_items), [SubscriptionSchedule.phases[].add_invoice_items[]](/api/subscription_schedules/object?api-version=2025-08-27.basil#subscription_schedule_object-phases-add_invoice_items), [SubscriptionScheduleCreateParams.phases[].add_invoice_items[]](/api/subscription_schedules/create?api-version=2025-08-27.basil#create_subscription_schedule-phases-add_invoice_items), [SubscriptionScheduleUpdateParams.phases[].add_invoice_items[]](/api/subscription_schedules/update?api-version=2025-08-27.basil#update_subscription_schedule-phases-add_invoice_items) | #### Go | Parameters | Change | Resources or methods | | -------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Metadata`, `Period` | Added | [InvoiceCreatePreviewScheduleDetailsPhaseAddInvoiceItemParams](/api/invoices/create_preview?api-version=2025-08-27.basil#create_create_preview-schedule_details-phases-add_invoice_items), [SubscriptionAddInvoiceItemParams](/api/subscriptions/create?api-version=2025-08-27.basil#create_subscription-add_invoice_items), [SubscriptionSchedulePhaseAddInvoiceItem](/api/subscription_schedules/object?api-version=2025-08-27.basil#subscription_schedule_object-phases-add_invoice_items), [SubscriptionSchedulePhaseAddInvoiceItemParams](/api/subscription_schedules/create?api-version=2025-08-27.basil#create_subscription_schedule-phases-add_invoice_items) | #### .NET | Parameters | Change | Resources or methods | | -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Metadata`, `Period` | Added | [InvoiceScheduleDetailsPhaseAddInvoiceItemOptions](/api/invoices/create_preview?api-version=2025-08-27.basil#create_create_preview-schedule_details-phases-add_invoice_items), [SubscriptionAddInvoiceItemOptions](/api/subscriptions/create?api-version=2025-08-27.basil#create_subscription-add_invoice_items), [SubscriptionSchedule.Phase.AddInvoiceItem](/api/subscription_schedules/object?api-version=2025-08-27.basil#subscription_schedule_object-phases-add_invoice_items), [SubscriptionSchedulePhaseAddInvoiceItemOptions](/api/subscription_schedules/create?api-version=2025-08-27.basil#create_subscription_schedule-phases-add_invoice_items) | ## Upgrade #### REST API 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 1. 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](https://docs.stripe.com/api/versioning.md) to include `Stripe-Version: 2025-08-27.basil` 1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 1. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### Ruby 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 1. Upgrade your Ruby SDK to [v15.5.0](https://github.com/stripe/stripe-ruby/releases/tag/v15.5.0) 1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 1. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### Python 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 1. Upgrade your Python SDK to [v12.5.0](https://github.com/stripe/stripe-python/releases/tag/v12.5.0) 1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 1. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### PHP 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 1. Upgrade your PHP SDK to [v17.6.0](https://github.com/stripe/stripe-php/releases/tag/v17.6.0) 1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 1. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### Java 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 1. Upgrade your Java SDK to [v29.5.0](https://github.com/stripe/stripe-java/releases/tag/v29.5.0) 1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 1. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### Node.js 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 1. Upgrade your Node SDK to [v18.5.0](https://github.com/stripe/stripe-node/releases/tag/v18.5.0) 1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 1. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### Go 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 1. Upgrade your Go SDK to [v82.5.0](https://github.com/stripe/stripe-go/releases/tag/v82.5.0) 1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 1. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### .NET 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 1. Upgrade your .NET SDK to [v48.5.0](https://github.com/stripe/stripe-dotnet/releases/tag/v48.5.0) 1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 1. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). ## Related changes - [Adds a name field to the customer portal configuration object](https://docs.stripe.com/changelog/basil/2025-08-27/customer-portal-config-name.md) - [Adds support for third-party tax on flexible billing mode subscriptions](https://docs.stripe.com/changelog/basil/2025-08-27/3p-tax.md)