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
- Download the template file:
- Navigate to Subscriptions.
- 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.
- Click Export Mass Order Entry to download the subscription information.
-
Download customer account information.
- Navigate to Customer Accounts.
- 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.
-
Download product catalog information.
- Navigate to Product Catalog.
- 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.
- Enter data from the subscription, customer accounts and product catalog files into the mass order entry template.
- Once you have prepared the file you are ready to upload it to Zuora:
- Navigate to Subscriptions and click Mass Order Entry.
- 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
|
Subscription Version |
No |
Internal Zuora ID
|
Account Number |
Yes |
Customer Account Number
|
Order Type |
No |
String defining the subscription type. For creating a subscription, the only possible value is
|
Order Name (amendments only) |
No |
Leave this empty.
|
Change Description (amendments only) |
No |
Leave this empty.
|
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?
|
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
|
Product Name |
No |
Product Name
|
Rate Plan ID |
Yes |
Internal Zuora rate plan ID
|
Rate Plan Name |
Yes |
Rate plan name
|
Rate Plan Component ID |
Yes |
Internal Zuora rate plan ID
|
Charge Name |
Yes |
Charge Name
|
Charge Description |
No |
Charge Description
|
Price |
No |
Price being charged
|
Quantity |
No |
Units being charged
|
# 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:
|
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 The |
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 This feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support.
|