Public preview
Adds support for previewing invoices before pausing a subscription Public preview
What’s new
You can now preview how pausing a subscription affects billing and subscription state. Include the subscription_details.pause hash when creating a preview invoice to get back a preview invoice and the projected subscription state after the pause, without modifying the actual subscription. To receive a preview invoice:
- invoicing_behavior must be invoice . pending _ invoice _ item returns a 404 error.
- bill_for must produce billable amounts for unused licensed time or outstanding metered usage. If pausing would not create debits or credits, the endpoint returns a 404 error.
Impact
You can now show customers or internal teams an accurate preview invoice before pausing. This helps reduce unexpected billing changes for your customers. See Preview the invoice before pausing for implementation details.
Changes
| Parameter | Change | Resources or endpoints |
|---|---|---|
| pause | Added | Invoice#create_preview. subscription_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-06-24. preview
- 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.
