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

Removes iterations parameter for subscription schedulesBreaking changes

What’s new

We’ve removed the iterations parameter because duration replaces its functionality.

Why is this a breaking change?

We no longer support the iterations parameter for Subscription Schedules.

Impact

You must update your integration to use duration to specify the length of a subscription schedule phase in the following API endpoints:

Using iterations in these endpoints now returns an error.

Before
After
Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
curl https://api.stripe.com/v1/subscription_schedules \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Version: 2025-08-27.basil" \
  -d customer={{CUSTOMER_ID}} \
  -d start_date=now \
  -d "phases[0][items][0][price]"={{PRICE_PREMIUM} \
  -d "phases[0][items][0][quantity]"=1 \
  -d "phases[0][iterations]"=3 \
  -d end_behavior=release
Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
curl https://api.stripe.com/v1/subscription_schedules \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d customer={{CUSTOMER_ID}} \
  -d start_date=now \
  -d "phases[0][items][0][price]"={{PRICE_PREMIUM} \
  -d "phases[0][items][0][quantity]"=1 \
  -d "phases[0][duration][interval]"=month \
  -d "phases[0][duration][interval_count]"=3 \
  -d end_behavior=release

Changes

ParameterChangeResources or endpoints
iterationsRemoved
Invoice#create_preview.schedule_details.phases[]SubscriptionSchedule#create.phases[]SubscriptionSchedule#update.phases[]

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-09-30.clover
  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