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
Billing
OverviewAbout the Billing APIs
Subscriptions
Invoicing
Usage-based billing
Quotes
Customer management
Billing with other products
Revenue recovery
Automations
Test your integration
    Overview
    Test clocks
      Simulate subscriptions
      API and advanced usage
    Test your invoicing integration
Tax
Overview
Use Stripe tax
Manage compliance
Reporting
Overview
Select a report
Configure reports
Reports API
Reports for multiple accounts
Revenue recognition
Data
OverviewSchema
Custom reports
Data Pipeline
Data management
HomeRevenueTest your integrationTest clocks

Simulate subscriptions

Learn how to simulate subscriptions in a sandbox.

Simulating a subscription shows you the events of a subscription, such as invoices and renewals, that are expected over the course of the simulation time.

Note

When you run a simulation on a subscription, it appears in the Test clocks tab of the Subscriptions page. You can delete it by clicking Finish simulation. Finishing a simulation deletes all objects associated with it, including the customer and subscription, from the sandbox. It doesn’t affect live mode.

To simulate a subscription:

  1. Open the Dashboard and create a sandbox.
  2. In the subscriptions page, click the subscription to test.
  3. Click Run simulation in the banner at the top of the page.

    Customer ineligible for simulation

    The Run simulation button might be disabled if the subscription’s customer:

    • Is attached to more than three subscriptions, including scheduled subscriptions
    • Has a complex profile, with many quotes, invoices or other related objects
  4. In the modal, set the date and time to simulate and click Advance time.

You can advance time by any increment, but you can only advance them two intervals at a time from the initial frozen time. For example, if you have a monthly subscription, you can only advance the clock up to two months at a time.

When the clock is done advancing, the banner updates and displays the clock’s current time.

You can continue to make changes to your simulation and advance the time for simulations like:

  • Adding a customer balance.
  • Making a mid-cycle upgrade.
  • Adding one-off invoice items.

Repeat as many times as you need to satisfy your test case.

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