Skip to main content

Create subscriptions through Mass Order Entry

Zuora

Create subscriptions through Mass Order Entry

Mass Order Entry lets you create subscriptions by uploading data in a comma-separated value (CSV) file. Use the information from the customer accounts and the product catalog to populate this file. 

Creating and amending subscriptions in the Zuora Billing UI is only relevant for existing Subscribe and Amend customers who have not transitioned to Orders or Orders Harmonization. Any new customers will not see this UI.

Mass Order Entry is end of support. Zuora no longer provides product support, and bug fixes or security issues are no longer be addressed. You are recommended to use ​​Developer Tools instead.

Limits

Records per Export Mass Order Entry File

200,000 records are allowed on an Export Mass Order Entry file. This large file contains every subscription and amendment that has been created for your Zuora tenant. 

Zuora recommends uploading up to 400 records per file for improved processing. 

Upload Subscription Information

Upload Subscriptions Using the Mass Order Entry Template

  1. Download the template file:
    1. Navigate to Subscriptions.
    2. On the right side of the Zuora interface, click Mass Order Entry Template and download the file (MassOrderEntryTemplate.csv). Note that some of the columns that appear in the file depend on your tenant settings and whether you are using custom fields.
  2. Click Export Mass Order Entry to download the subscription information.
  3. Download customer account information.

    1. Navigate to Customer Accounts.
    2. On the right side of the Zuora interface, click Export Customer Accounts and download the file. 

    The Export Customer Accounts functionality is deprecated and not available by default. See Data Exports. As an alternative, you can export customer account information by exporting data from the Account data source and related data sources. See Generate a Data Source Export for more information.

  4. Download product catalog information.

    1. Navigate to Product Catalog.
    2. On the right side of the Zuora interface, click Export Product Catalog and download the file (ExportProductCatalog.csv).

    The Export Product Catalog functionality is deprecated and not available by default. See Data Exports. As an alternative, you can export product catalog information by exporting data from the Product data source and related data sources. See Generate a Data Source Export for more information.

Assemble the CSV Data File

See Mass Order Entry Field descriptions in the following section for more information.

  1. Enter data from the subscription, customer accounts and product catalog files into the mass order entry template. 
  2. Once you have prepared the file you are ready to upload it to Zuora:
    1. Navigate to Subscriptions and click Mass Order Entry.
    2. Click Browse to navigate to the file, then click submit.

Note that you should use UTF-8 to encode the CSV file.

Mass Order Entry Fields

The following table describes the information that you can enter in the Mass Order Entry template. 

If you have more than 200,000 records, the following error is returned:

<timestamp> The total number of records to be exported exceeds the maximum limit of 200000, please contact customer support to complete the export request. 

Column Required? Description

(custom fields)

No

If you have create custom fields for Rate Plan Charge, download the template after creating them, and they will automatically appear in the template.

Subscription Code

Yes

Internal Zuora ID

  • Enter New for the first line of a subscription.

  • If there is more than one charge in the subscription, enter Prev for any subsequent lines for that subscription.

Subscription Version

No

Internal Zuora ID

  • Leave this empty

Account Number

Yes

Customer Account Number

  • Must be a valid customer account. Will be the account numbers provided from the customer load if they were previously provided.

  • Example: A00001201

Order Type

No

String defining the subscription type. For creating a subscription, the only possible value is 

  • Create Subscription

Order Name (amendments only)

No

Leave this empty.

  • Name of the Amendment

Change Description (amendments only)

No

Leave this empty.

  • Enter a description for your change.

Initial Term

Conditional

Initial Term of the Subscription. Must be 1 or greater.  Use only when Subscription Term Type is TERMED - leave empty when Subscription Term Type is EVERGREEN.

Renewal Term

Conditional

Renewal Term of the Subscription. Must be 1 or greater.  Use only when Subscription Term Type is TERMED - leave empty when Subscription Term Type is EVERGREEN.

Term Commitment

No

Leave this empty

AutoRenew

Conditional

Should you set the subscription to autorenew?

  • Optional: TRUE or empty.

  • Use when Subscription Term Type is TERMED. Leave empty when Subscription Term Type is EVERGREEN.

Term Start Date

Optional

Start of of the new subscription term, as MM/DD/YYYY. Basis of renewal date. If left empty, it will default to the Contract Effective Date once the subscription has been imported to Zuora.

Save as Draft

No

Optional. TRUE or empty

Contract Effective Date

Yes

Effective Date of the contract, as MM/DD/YYYY

Service Activation Date

Yes

Activation Date of the contract, as MM/DD/YYYY

Customer Acceptance Date

Yes

Date upon which the customer will accept the contract, as MM/DD/YYYY

Cancel Subscription Date

No

Leave this empty

Product SKU

No

Product SKU

  • As entered in the product catalog. Using the extract of the product catalog, use an appropriate value from the SKU field on the Product tab.

  • Example: SKU-00000107

Product Name

No

Product Name

  • As entered in the product catalog. Using the data sources extract of the product rate plan charge (which includes data on the product, rate plan, and rate plan charge), use a value from the Product: Name field. It should correspond to the SKU.

  • Example: Ultimate Screen Capture

Rate Plan ID

Yes

Internal Zuora rate plan ID

  • Enter the rate plan ID, or leave empty. If left empty, this will be updated by Zuora based on the rate plan name provided in the next column.

  • Using the data sources extract of the product rate plan charge (which includes data on the product, rate plan, and rate plan charge), use the value from the Product Rate Plan ID field.
    Example: 4028e6963716432e013733b3aaf36ea9

Rate Plan Name

Yes

Rate plan name

  • As entered in product catalog.

  • Using the data sources extract of the product rate plan charge (which includes data on the product, rate plan, and rate plan charge), use the value from the Product Rate Plan: Name field.

Rate Plan Component ID

Yes

Internal Zuora rate plan ID

  • Enter the rate plan charge ID, or leave empty. If left empty, this will be updated by Zuora based on the charge name provided in the next column.

  • Using the data sources extract of the product rate plan charge (which includes data on the product, rate plan, and rate plan charge), use the value from the Product Rate Plan Charge ID.
    Example: 4028e6963716432e013733b5b29273f3

Charge Name

Yes

Charge Name

  • As entered in the product catalog. 

  • Enter the charge name

  • Using the data sources extract of the product rate plan charge (which includes data on the product, rate plan, and rate plan charge), use the value from the Product Rate Plan Charge: Name.

Charge Description

No

Charge Description

  • Leave empty or enter the charge description as it appears in the product catalog.

Price

No

Price being charged

  • Enter a price in the format #####.## (for example, 12345.67)

Quantity

No

Units being charged

  • Number only

  • Enter if applicable to the charge type you are using. Some charges do not require Quantity.

# Periods To Prepay

No

Leave this empty

Overage Included Units

No

Leave this empty.

Enter if applicable to the charge type you are using.

Overage Price

No

Leave this empty

Enter if applicable to the charge type you are using.

Overage (Smoothing) # Periods

No

Leave this empty

Enter if applicable to the charge type you are using.

Accounting Code

No

Accounting code

Leave empty. The accounting code will be populated by Zuora and is the accounting code inherited from the product rate plan charge.

Revenue Recognition Code

No

Enter the Revenue Recognition Code as configured on the charge line.

Revenue Recognition Trigger Date

No

Enter the Revenue Recognition Trigger Date as configured on the charge line. Possible values are as follows:

  • Contract Effective Date
  • Service Activation Date
  • Customer Acceptance Date

Subscription Term Type

Yes

Specify TERMED or EVERGREEN

Overage Credit Back Option

No

Leave empty. The accounting code will be populated by Zuora and is the accounting code inherited from the product rate plan charge.

Overage Credit Back Rate

No

Leave empty. The accounting code will be populated by Zuora and is the accounting code inherited from the product rate plan charge.

Invoice Separate

No

Leave empty. This column may not be present in the template you download, depending on your tenant setting for the option "Enable Subscriptions to be Invoiced Separately".

Price Increase Percentage

No

Leave empty. Optional.

Use Discount Specific Accounting Code

No

Leave empty. Optional.

Invoice Account Number

No

Leave empty. Optional.

Destination Account Number

No

Leave empty. Optional.

Destination Invoice Account Number

No

Leave empty. Optional.

Usage Record Rating Option

No

Leave empty. Optional.

Billing Period

Optional

Billing period for the charge.

Specific Billing Period

Conditional

Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the Billing Period field to Specific Months or Specific Weeks

The Specific Weeks in the Billing Period field is in Limited Availability

Billing Period Alignment

Optional

Aligns charges within the same subscription if multiple charges begin on different dates.

Billing Timing

No

Billing timing for the subscription. Can be In Advance or In Arrears.

This feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support