Skip to content
Create account or Sign in
The Stripe Docs logo
/
Create accountSign in
Overview
Versioning
Changelog
Upgrade your API version
Essentials
Stripe CLI
Tools
Stripe for Visual Studio CodeStripe Discord server
Features
Stripe health alertsStripe SignalsFile uploads
AI solutions
Model Context ProtocolAgent skillsStripe Directory
Extend Stripe
OverviewCustom objects
Security and privacy
Activity logsStripebot web crawler
Partners
Partner certification
Breaking changes

Renames the rendering_options attribute for invoices to renderingBreaking changes

What’s new

Renames the rendering_options attribute for invoices to rendering.

Impact

Renaming the rendering_options attribute for invoices to rendering simplifies the attribute’s name. You need to update your code to access and modify these invoice rendering settings under the new rendering structure.

Changes

ParameterChangeResources or endpoints
rendering_optionsChanged
Invoice
FieldChangeFrom → to
Invoice.rendering_optionsChanged
nullable(map(string: string)) → InvoiceSettingRenderingOptions

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: 2024-04-10
  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.

On this page