Nue Knowledge Center

Nue Docs navigation

search
clear
/

Import Subscriptions into Nue

Import Subscriptions into Nue

 

By consolidating all your subscriptions in Nue, you can manage and track your customers' lifecycle (e.g. renewals, upsells, downsells, etc.) in a single place.

 

Active subscriptions can often be associated with products and services that are no longer available. Nue will allow you to create products and services that have been discontinued so that imported subscriptions can continue to be renewed.  

 

This migration is targeted towards active subscriptions, whose end date is greater than today. This migration will create an Order and a Subscription for each row in the template.

 

Active subscriptions can be imported as bundled subscriptions (e.g. bundled products), or as individual subscriptions.

Note: If extensive and manual effort is required to pull the active subscriptions from contracts or various sources, we recommend using a BPO vendor.

 

Step 1: Create Products in Nue

 

In this step, you will want to make sure that all products and pricing are created. The best practice is to validate in Salesforce Sandbox first for a handful of subscriptions, so create the products and pricing needed in Nue Sandbox.

 

  • Create all products in Nue
  • If the products are no longer sold, make sure to end date the products

Step 2: Prep your Data

 

This step is likely going to be the most effort. Querying for all active subscriptions, identifying the appropriate fields (e.g. Subscription Start/End Date, Quantity, List Price, etc.), exporting the data will often take a significant amount of time.

 

  • Identify your active subscriptions (Subscription End Date >= Today)
  • Create the active subscription list by using the Nue Subscription Import Template
  • Ensure that your Salesforce Sandbox can be used to validate the subscriptions (account ids, product ids, etc. all exist in sandbox) 

Step 3: Validate in Sandbox

 

Our best practice is to identify a sample set to test in Sandbox. This will allow you to see how the import process will work.

 

  • Nue team will import the subscriptions into Salesforce Sandbox 
  • The import process will create an Order and a Subscription for each row on the template
  • Customer will validate that the data looks accurate and the Orders and Subscriptions were created correctly

Step 4: Import to Production

 

  • Nue team will import Orders and Subscriptions in Production once the customer confirms that the Sandbox validation is complete
  • Customer will confirm that Orders and Subscriptions were created

Guidelines

 

#

Guideline

Examples/Notes

1

Only active subscriptions (where Subscription End Date >= Today) will be imported into Nue.

If today is 5/3/22, we will create subscriptions if the end date is 5/3/22 or greater.

2

You will want to validate in your Salesforce Sandbox first. This means that any Account IDs associated with active subscriptions will need to exist in Salesforce Sandbox.

Make sure the Account IDs, Product Ids, etc. exist in your Sandbox.

3

If you are mapping old products to new products for these subscriptions, make sure you associate the correct Product ID.

If the subscriptions will be auto-renewed on legacy products, make sure those products exist in Sandbox. You can auto-renew on an old product, and prevent these products from being sellable by the Sales Team. This is done easily in Nue by end-dating the product.

4

Each active Subscription should be a single row on the Import File. This means that the Subscription should not be split into multiple rows, but rather it is a single row with a Total Price that represents the total amount for the length of the Subscription.

A 36 month subscription, with a 12 month renewal term will have a single row in the import file:

  • Subscription Start Date
  • Subscription End Date
  • 36 month Subscription Term
  • 12 month Renewal Term
  • Total Price for the 36 months

5

Note that all IDs should be the 18 character case-sensitive ID, from Salesforce, and not the 15 character ID.

For years, Salesforce's record ID was 15-characters case sensitive. However, a lot of data stores did not support case sensitive IDs. So, Salesforce ran an algorithm to append 3 characters to make IDs case sensitive. Make sure you get the 18-character ID from the URL.

6

The import will not support product bundles. Since the bundles can be configured in various configurations, Nue can only support individual products.

Each row in the sheet will create a new Order and Subscription.

 

Import Data 

 

Note that these fields must exist in the Salesforce Sandbox environment in order to validate.

 

Refer to the Nue Subscription Import Template.

 

Field Name

Description

Required

id

The ID of the subscription, used when importing subscription bundles. This can be any string that is unique in the import file.

 

This field is only used when importing a product bundle. Leave this blank if the subscription is not part of a bundle.

No

parentId

The ID of the parent subscription when importing subscription bundles. This is the ID of the parent subscription in the file.

 

This field is only used whe importing a product bundle. Leave this blank if the subscription is not part of a bundle.

No

customerId

The account ID in Salesforce.

Yes

productId

The product ID in Salesforce (referring to the Nue product).


Please use the 18-character Product ID. Note that the 15-character Product ID is not case sensitive, so we require the 18-character ID.

Yes

productOptionId

Product Option ID for the child subscription used when importing subscription bundles.

 

See this article for more information on Product Options.

Yes (when parentId is not empty)

productOptionQuantity

Product Option Quantity is used for the child subscription when importing subscription bundles.

 

When the child subscription is a "bundled" one, set the ProductOptionQuantity = 1.

Yes (when parentId is not empty)

priceBookId

The Price Book ID that the price book entry ID is associated with.

Yes

priceBookEntryId

The price book entry ID in Salesforce (referring to the Nue price book entry). This should match the UOM ID and the Currency ID.

Yes

uomId

The UOM ID in Salesforce.

Yes

quantity

Quantity of the product or service.

Yes

salesPrice

The sales price, calculated by Total Price / Subscription Term / Quantity.

Yes

totalPrice

The total price of this subscription.

Yes

totalAmount

The total amount, which for now is equal to the total price.

Yes

termDimension

The term dimension of the Unit of Measure. It is either in Month or Year.


If not provided, the default value is Month.

No

subscriptionTerm

The subscription term is in Month or Year. 

Yes

subscriptionStart Date

The subscription start date. 

Yes

subscriptionEndDate

The subscription end date. 

Yes

autoRenew

Indicates if the subscription should be auto-renewed. Valid values are true; or false; (make sure it's lower case). The default value is false.

No

renewalTerm

This is the renewal term. The default value is 12 (months).

No

bundled

If the subscription is bundled (included), then set this value to 'true'.

 

If the subscription is an 'add-on', then set the value to 'false'. The default value is 'false'.

No

evergreen

Indicates if this order or subscription contains an evergreen product.  By default the value is false.  If the Subscription Term is NULL, or Subscription End Date is NULL, the subscription will be considered evergreen, thus this value will be set to true during the import process. 

No

billingAccountId

This is the Billing Account ID for the Order. In the case that the Billing Account is different than the Customer Account, then you can specify the Billing Account ID in this field.

No

billingTiming

The Billing Timing of the subscription. If this field is not specified, the account or system level setting will be used.

No

billingPeriod

The Billing Period of the subscription. If this field is not specified, the account or system level setting will be used.

No

billCycleDay

The Bill Cycle Day of the subscription. If this field is not specified, the account or system level setting will be used.

No

billCycleStartMonth

The Bill Cycle Start Month of the subscription. If this field is not specified, the account or system level setting will be used.

No