Skip to main content

Resume Subscriptions

Zuora

Resume Subscriptions

This guide will walk you through the steps to resume a list of subscriptions, with an option to extend the subscription term date. The end result is two subscription amendments:  Resume Subscription and Terms and Conditions to update the term date.

Data changes caused by workflows cannot be undone. Zuora recommends that you fully test your workflows in the Zuora API Sandbox environment before running them in the Production environment.

Overview

What is it?

The Resume Subscription workflow allows you to resume a list of subscriptions, along with an option to extend the subscription to a future date. 

Why does it matter?

To quickly respond to getting back to business, this workflow will allow you to resume a list of subscriptions. If your business is seeking to resume subscriptions, this workflow is an efficient way to do so. 

How does it work?

The Resume Subscriptions workflow iterates through a list of subscriptions and creates a subscription amendment. If you also opt to extend the subscription period, another subscription amendment would be created extending the term date.

The resume date is using the FixedPeriodsFromSuspendDate parameter. This means that the number of periods field in the CSV is required for this workflow to execute.

  • Subscription: The list of subscriptions to resume.
  • Auto Extend: This is an optional parameter to extend the subscription term date after a number of billing periods (Y or N).
  • Number of Billing Periods: This value defines the number of billing periods to resume the subscription.

If you wish to resume, which does not match the billing period structure, you can use these override settings:

  • Use Specific Suspension Period Type: If this option is checked, the workflow will look at the next field, Suspension Period Type.
  • Suspension Period Type: The valid values here are Day, Week, Month, or Year. The value in the input file (column name is Number of Billing periods) will determine the number of days, weeks, months, or years to resume the subscription.

Note that no invoices will be created by this workflow.

Getting started

Data changes caused by workflows cannot be undone. Zuora recommends that you fully test your workflows in the Zuora API Sandbox environment before running them in the Production environment.

 

Step 1: Create a list of subscriptions

In this step, create the input file to be used by the workflow.

Step

Description

Create your list of invoices

Create a CSV file to capture your list of subscriptions that you want to resume. Your file can include the following columns:

SubscriptionNumber, AutoExtend, NumberOfBillingPeriods 

• SubscriptionNumber identifies all the subscriptions that you want to resume.

• AutoExtend is either Y to auto-extend the subscription term date, or N.

• NumberofBillingPeriods is the number of billing periods that you want to resume. This number will also be used to define the number of periods (Day, Week, Month, Year) to resume if a different suspension period type is used.

covid_resume_1.png

You can use Datasource Export to create your file.

Here is an example CSV file that you can view or download: Resume_Subscription_example.csv

Step 2: Execute the workflow to resume subscriptions

In this step, execute the workflow.

Steps

Description

Navigate to Workflow

Navigate to Platform > Workflow > Workflows.

Create a new workflow

In the Workflows tab, click the plus icon ( + ) and click From Template > COVID-19 > Resume Subscriptions.

Open the workflow

Click the workflow, and you will see the following.

Resume_Subscription_Workflow.png

Workflow tasks overview

You will notice a number of tasks in this workflow:

• Resume Subscription: This is the starting point; clicking on the arrow will open up a prompt to enter the list of invoices (CSV file), and other input parameters.

• Get Subscription Info: This check will determine whether your tenant is using the Invoice Settlement feature.

• Using Orders or Amendments: If the Orders feature is enabled, a Resume Order will be created; otherwise, a subscription amendment will be created.

• Get Subscriptions with Failed Amendment: In the case of a failure in creating an amendment, the list of subscriptions that failed will be emailed to the email address indicated in the parameters.

Input parameters

Click the arrow in the green box. When prompted to confirm, click OK.

Resume_Subscription_Start.png

The new workflow run window will open. You need to specify input parameters for the workflow.

covid_resume_4.png

1. Orders Option - Select this option if you are using Orders.

2. Click Choose File and select the file that you created in Step 1. Note that a file is needed to execute the workflow. The file can include Subscription Number, Auto Extend, and Number of Billing Periods columns. The Number of Billing Periods columns is required.

3. Enter the email to be sent an attachment with the list of Subscriptions that failed to be updated (note that an email will not be sent if there were no errors found).

4. Use Specific Suspension Period - Select this option if you’d like to specify the specific suspension period, rather than the default billing period.  

5. Suspension Period Type - Indicate Day, Week, Month, Year in the type. The number of billing periods used will be read from the input file.

6. The Debug Only option can be selected if you don’t want to execute the actual change, but rather test to see which subscriptions would have been updated.

Execute the workflow

Data changes caused by workflows cannot be undone. Zuora recommends that you fully test your workflows in the Zuora API Sandbox environment before running them in the Production environment.

After you click Run, the workflow will execute.

You can view the results in the Run History tab.

Screen Shot 2020-05-26 at 12.21.09 PM.png

Clicking Tasks will show you the results of each task.

Screen Shot 2020-05-26 at 12.24.25 PM.png

Resume order is created

covid_resume_7.png

Subscription amendments

Two subscription amendments will be created if you opted to resume and extend the subscription.

Resume subscription amendment:

covid_resume_8.png

Extend subscription amendment:

covid_resume_9.png