Import Requirements: Subscriptions – Ordway Support Portal

View our Walkthrough article for Updated Subscription Pricing & Remove Charge.

Refer to the following tables providing all available fields along with required fields when importing Subscriptions.

Note: Importing Subscriptions includes a tab for Subscriptions, Plans, Tiers, & Transaction Posting Entries.

The tabs required for a successful import depend on what data is being imported.

Key

X indicates a required field.

* indicates the field may be required based on settings and/or additional selections.

Subscription Tab

Fields	Create	Update	Activate	Renew	Cancel	Valid Values	Notes
ID	X	X	X	X	X
Customer ID	X
Billing Contact ID
Shipping Contact ID
Contract Term	X	X					If no value specified, defaults based on general settings. When Termed is selected, a Contract Term End Date is required.
Renewal Term							If no value specified, defaults based on general settings.
Auto-Renew						-Yes (default) -No	If no value specified, defaults based on general settings.
Currency
Exchange Rate
Status			X	X	X	-Active -Draft (Default) -Cancelled -Renew
Coupon Code
Separate Invoice						-No	Leave blank to include imported subscriptions in Billing Runs.
Contract Effective Date	X	X		X			Renewals will default to 1 day after the previous contract term end date.
Billing Start Date	X			X
Service Start Date	X			X
Cancellation Date					X		If not specified, we will default to the current date in UTC Time.
Cancellation Type						-End of Current Period -End of Previous Period -End of Contract Term	If the Cancellation Date is not provided, Cancellation Type is used to determine the date. Note: This field is not included in exports, but can be manually added prior to import.
Current Term Start Date
Current Term End Date							When Termed is selected as the Contract Type, this field is required.
Payment Term
Notes
Auto Price Percent Increase on Renewal
Defer Start Date						-Yes -No
renewal_increment_percent
Coupon Code
Custom Fields

Plans Tab

Fields	Create	Update	Activate	Renew	Cancel	Valid Values	Notes
Subscription ID	X	X		X
Subscription Line ID	*						Required if populating tiers.
Plan ID	X
Plan Name
Product ID	X
Product Name
Charge ID		X		X
Charge Name
Charge Type						-One Time -Recurring -Usage Based
Quantity
Discount
Effective Price							Read Only. (List price * Quantity - Discount)
Pricing Model						-Per Unit (default) -Volume -Tiered
Charge Timing						-In Advance -In Arrears	If no value specified, defaults based on general settings.
Charge Start Date							If no value specified, defaults based on Subscription Start Date. One time charge-leave blank.
Charge End Date							If no value specified, defaults based on Subscription End Date. One time charge-leave blank.
List Price
List Price Base
Included Units
Billing Period
Unit of Measure
Charge Billing Date
Completion Date
Prorate Partial Periods						-Yes (Means Partial Period Proration is ON) -No	If not provided, defaults to No. When this field and Backcharge Current Period are set to NO or are blank, Next Full Period is used.
Backcharge Current Period						-Yes (Means Current Full Period is ON) -No	If not provided, defaults to Next Full Period.
Prepayment Periods							06/08-this appears to be a new field added since Import/Export release.
Prepayment Quantity
Enable Prepaid Units
Auto Refill Prepaid Units						-Yes -No
Auto Refill Quantity
Refill Prepaid Units for						-Billing Period -Contract Renewal
Prepaid Units Expiry						-Billing Period -Contract Term -Perpetual
Refund Units on Cancel						-Yes -No
Remove Lines on Cancel						-Yes -No
Renewal Increment Percent
Override Renewal Increment Percent						-Yes -No
Default From Plan						-Yes -No	Determines the Accounting Information for a subscription charge. If true, the Accounting Information is defined by the Plan. When false, the Accounting Information can be overridden and is no longer associated with the Plan. If no value is passed, the default value is set to true.
Revenue Rule ID							Default: Revenue Rule ID associated with Plan selected for the Charge.
Recognition Start Date						-Billing Start Date -Completion Date -Charge Start Date -Invoice Date (default)

Tiers Tab

*Note: When updating Tiers or Transaction Posting Entries, you must include all of the records and fields in the import file. The import process overwrites the records on update by deleting all of the records for that subscription and creating new records from the import file.

Fields	Create	Update*	Activate	Renew	Cancel	Valid Values	Notes
Subscription ID	*	*		*			If using tier based charges, these fields are required.
Subscription Line ID	*	*		*
Starting Unit	*	*		*
Ending Unit	*	*		*
Price	*	*		*
Type	*	*		*		-Per Unit -Flat Fee
Tier	*	*		*

Transaction Posting Entries Tab

Use this tab to override the default GL Accounts for specific types of transactions on each Subscription Charge.

Please refer to this article for more information on the default GL accounts and updating accounting information for specific transaction types such as Orders/Contracts, Invoice Posting, and Revenue Schedules.

Fields	Create	Update*	Activate	Renew	Cancel	Valid Values	Notes
Subscription ID	*	*		*			If Finance Enabled, these fields are required. When not provided, will default to the Transaction Posting Accounts on the plan.
Subscription Line ID	*	*		*
Transaction Type	*	*		*		-Orders/Contract -Invoice Posting -Revenue Schedule
Debit Account	*	*		*
Credit Account	*	*		*

Key

Subscription Tab

Plans Tab

Tiers Tab

Transaction Posting Entries Tab

Related articles