Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Revenue
Platforms and marketplaces
Money management
Developer resources
Overview
Versioning
Changelog
    Overview
    Basil
    Acacia
    Previous versions
Upgrade your API version
Upgrade your SDK version
Essentials
SDKs
API
Testing
Stripe CLI
Sample projects
Tools
Workbench
Developers Dashboard
Stripe Shell
Stripe for Visual Studio Code
Features
Workflows
Event destinations
Stripe health alertsFile uploads
AI solutions
Agent toolkit
Model Context Protocol
Security and privacy
Security
Stripebot web crawler
Privacy
Extend Stripe
Build Stripe apps
Use apps from Stripe
Partners
Partner ecosystem
Partner certification
HomeDeveloper resourcesChangelogBasil2025-08-27.basil

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 generated by subscriptions and subscription schedules:.

  • 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 or Update subscriptions.
  • Create or Update schedules.
  • Create a preview invoice by specifying the schedule_details.

Changes

ParametersChangeResources or endpoints
metadataperiodAdded
Invoice#create_preview.schedule_details.phases[].add_invoice_items[]Subscription#create.add_invoice_items[]Subscription#update.add_invoice_items[]
 + 3 more
SubscriptionSchedule.phases[].add_invoice_items[]SubscriptionSchedule#create.phases[].add_invoice_items[]SubscriptionSchedule#update.phases[].add_invoice_items[]

Upgrade

  1. View your current API version in Workbench.
  2. 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.basil
  3. Upgrade the API version used for webhook endpoints.
  4. Test your integration against the new version.
  5. If you use Connect, test your Connect integration.
  6. In Workbench, perform the upgrade. You can roll back the version for 72 hours.

Learn more about Stripe API upgrades.

Related changes

  • Adds a name field to the customer portal configuration object
  • Adds support for third-party tax on flexible billing mode subscriptions
Was this page helpful?
YesNo
  • Need help? Contact Support.
  • Join our early access program.
  • Check out our changelog.
  • Questions? Contact Sales.
  • LLM? Read llms.txt.
  • Powered by Markdoc