Welcome to Zuora Product Documentation

Explore our rich library of product information

Suspend and Resume subscriptions in Quote Studio

Enable Salesforce users to suspend and resume subscriptions directly in Quote Studio, configure suspend and resume details, and control access through permissions.

This feature enables Salesforce users to suspend and resume subscriptions directly in Quote Studio. It is available starting with Zuora Quotes version 10.57 for Single Subscription Quoting (SSQ) and version 10.59 for Multi Subscription Quoting (MSQ).

With this feature, you can:

  • Suspend an active subscription from the Billing Account and Subscription Selector section.

  • Resume a suspended subscription from the same page.

  • Configure suspend and optional resume details using:

    • A quick suspend/resume flow using icons or buttons.

    • The Quote Studio page while creating or editing a quotes (New, Amend, Renew).

Icons, Buttons, and States

On the Billing Account and Subscription Selector page in Quote Studio:

  • For active subscriptions, users with suspend permission see:

    • Amend, Renew, Cancel, and Suspend icons and buttons

  • For suspended subscriptions, users with resume permission see:

    • Only the Resume icon and button. Amend, Renew, and Cancel are not available while the subscription is suspended.

You cannot cancel a subscription while it is suspended. You must first resume it and then perform other order actions such as amend, renew, or cancel.

Multi Subscription Quoting button visibility and selection behavior

In Multi Subscription Quoting (MSQ), the Suspend Selected and Resume Selected buttons on the Billing Account and Subscription Selector page depend on the state of the selected subscriptions.

If you select one or more active subscriptions, the Suspend Selected button is enabled. Amend Selected and Renew Selected buttons remain available for the selected active subscriptions.

If you select one or more suspended subscriptions only, the Resume Selected button is enabled.

If you select a combination of active and suspended subscriptions, Zuora CPQ displays an error and does not allow a bulk action on that mixed selection. To continue, clear the mixed selection and then select subscriptions that are all in the same state.

This behavior is specific to the subscription state of the selected rows and helps ensure that bulk suspend and bulk resume actions are performed only on valid subscription groups.

Prerequisites and other considerations

  • Suspend and Resume actions are available for:

    • New - create a subscription that will later be suspended or created directly in Suspended state.

    • Amend

    • Renew

    Note:

    You cannot cancel a subscription in the same flow where you suspend or resume it. Cancel actions are available only when the subscription is not suspended.

  • If your Salesforce org uses multi-entity subscriptions, Zuora CPQ now includes the entity ID in suspend and resume requests. This ensures that suspend and resume actions are processed correctly in multi-entity environments.

  • You must also have the required profile-based permissions configured by an administrator in Zuora Config > Quote Studio Settings > Feature Access Config.

    Administrators can also use the Billing Account Plugin to control which users can view the Suspend and Resume options on the Billing Account and Subscription Selector page in Quote Studio. See quote type selection.

    Note:

    Suspend/Resume is disabled by default for all users.

  • From Quotes version 10.59, you can also use the suspendSubscription and resumeSubscription global methods to suspend or resume subscriptions programmatically. See zQuoteUtil class.

  • This feature works with the CPQ X Extensibility Framework and Rules Engine.

    • You can use the Extensibility Framework to set the appropriate suspend or resume fields and optionally display a toast message confirming that your changes were applied.

    • Use the link below for sample code to suspend and resume related fields. Follow the same pattern used in below sample, which demonstrates how to change the Quote Name using the beforeSave and beforePreviewCall hooks along with the updateQuote and toastMessageDisplay events. You can adapt this sample to set suspend or resume fields instead of updating the Quote Name.

      See sample code.