Skip to content
Create account or Sign in
The Stripe Docs logo
/
Create accountSign in

Replaces Upcoming Invoice API methods with the Create Preview Invoice APIBreaking changes

What’s new

We’re removing the GET /v1/invoices/upcoming API in favor of the Create Preview Invoice API.

Additionally, you can no longer preview the next invoice for a customer across all their subscriptions on the Create Preview Invoice API.

Why is this a breaking change?

  • The Upcoming Invoice API methods are no longer available.
  • You must pass specific subscription details (subscription, subscription_details.items, schedule, schedule_details.phases, or invoice_items) along with the customer parameter to the Create Preview Invoice API.

Impact

Migrate your integration from GET /v1/invoices/upcoming or GET /v1/invoices/upcoming/lines API methods To use the Create Preview Invoice API. It offers equivalent functionality and parameters.

Changes

Endpoints ChangeResource
upcomingLinesupcomingRemoved
Invoice

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-03-31.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

Was this page helpful?
YesNo