Skip to main content
knowledgecenter.2checkout.com

Import subscriptions

Overview

Migrate subscription and data from your or a third-party system and store it securely in the 2Checkout vault.

Availability

2Checkout Enterprise Edition accounts.

Requirements

  1. PCI compliance. All entities involved in the process of migrating sensitive card information need to be PCI compliant. 2Checkout enjoys a Level 1 PCI DSS certification. Before moving forward with any data migration you need to contact 2Checkout Support directly for the compliance.
  2. Valid import data. Filter data to migrate only active subscriptions and customers into the 2Checkout platform.
  3. Pre-migration checklist. Match all requirements on the pre-migration checklist.

Costs

Contact 2Checkout Support directly to inquire about subscription and card migration costs.

Filter import data

To minimize the risk and rate of refunds/chargebacks, filter the import data and communicate your customers to only migrate those who are aware that 2Checkout will process future recurring charges or manual payments.

Pre-migration checklist

eStore

  • Configure the products for which you’re importing subscriptions using the 2Checkout Control Panel. Match the 2Checkout Product ID of configured items with the product ID of subscriptions you’re importing via the CSV file, or the import process will fail. Also, make sure the renewal settings are correctly configured for each product.
  • Build a valid CSV file using the structure guidance described below, and include all mandatory fields.

Partner channel subscriptions

  • On top of the requirements above, also configure partner details in the 2Checkout Control Panel and use their unique partner ID when importing new subscriptions.

Data format and structure

To import:

  • Package the data as CSV (comma separated values) file.
  • Include the mandatory items described below on the header line and populate values where information is also required.

Field name

Type

Required

Can be empty?

Description

LicenseUniqueId

string (max length 250 chars)

Yes

Yes

Your unique identifier for the subscription. You can use the LicenseUniqueId to map identifiers in your own system with subscription IDs in 2Checkout. 

Can be empty only if you supply the LicenceCode.

LicenceCode

string

No

Yes

System-generated 2Checkout unique subscription reference. 
Can be empty only if you supplied the LicenseUniqueId.

When first importing subscriptions into the 2Checkout system, LicenceCode is not required.

AvangateIdProduct

numeric

Yes

No

Must match the product ID of an item configured in the 2Checkout platform.

PurchaseDate

datetime

Yes

No

Subscription purchase date. Format: yyyy-mm-dd hh:mm:ss. Default time zone is GMT +2.

ExpirationDate

datetime

Yes

No

Subscription expiration date. Format: yyyy-mm-dd hh:mm:ss. Default time zone is GMT +2. 

ProductName

String (max length 155 chars)

Yes

No

The product name.

Quantity

numeric

Yes

No

2Checkout renews subscriptions using this number of units.  

FirstName

String (max length 40 characters)

Yes

No

End user first name.

LastName

String (max length 40 characters)

Yes

No

End user last name.

Email

String (max length 80 characters)

Yes

No

End user email. 2Checkout uses it to send out email notifications.

IdPartner

string

No

No

The unique ID of the partner. This field is required and cannot be empty when importing Partner channel subscriptions.

Language

string

Yes

No

ISO 639-1 two-letter code. 2Checkout sends out notifications in the language you assign to the subscription. Supported languages available are the ones activated for your account. When not provided, the default value is: en.

ProductVersion

String (max length 50 characters)

Yes

No

Subscription product version.

ProductExtra

String (max length 100 characters)

Yes

No

Product additional information. See sales links for details.

Company

String (max length 50 characters)

Yes

No

Business customer company name.

Phone

String (max length 40 characters)

Yes

No

End user phone.

Fax

String (max length 40 characters)

Yes

No

End user fax.

Address1

String (max length 100 characters)

Yes

No

End user address.

Address2

String (max length 100 characters)

Yes

No

End user address (additional).

Zip

String (max length 20 characters)

Yes

No

End user zip code.  Required when the provided CountryCode is "US".

City

String (max length 30 characters)

Yes

No

End user city.

State

String (max length 30 characters)

Yes

No

End user state. Required when the provided CountryCode is “US”

CountryCode

string (max length 2 characters)

Yes

No

Two-letter customer ISO country code.

ProductOptions

string (max length 255 characters)

Yes

No

Product options codes separated by "//". When specified, the product options codes must match pricing options of existing pricing configurations.

ActivationCode

String (max length 255 characters)

Yes

No

The delivered activation code for the product. Activation codes have to be unique.

ExternalCustomerId

String (max length 255 characters)

No

No

The identifier for same customer using one or more subscriptions.  Cannot be empty if you include the header in the file.

RenewalPriceListCode

string

Yes

No

Use this parameter to attach a specific price list to an imported subscription.

The 2Checkout system uses the price list to calculate the costs for the renewal process of the subscription.

You need to assign the price list to the partner defined using IdPartner and also assign the product set using AvangateIdProduct to the price list using the RenewalPriceListCode specified.

2Checkout validates the fact that IdPartner, RenewalPriceListCode and 2CheckoutIdProduct are linked.

If you do not attach a price list to a subscription, 2Checkout uses the first pricing list assigned to the partner that also contains the product with which the subscription is associated.

Value

numeric

No

No

Subscription value. The total costs incurred by the customer through the lifecycle of the subscription before you imported the subscription into the 2Checkout system.

When you provide it you must also set ValueCurrency.

 

2Checkout uses this information to calculate the subscription value and total customer value.

2Checkout converts values into your account’s default settlement currency using the exchange rate at the time of the import, unless ValueCurrency is the same as the default settlement currency.

ValueCurrency

String (max length 3 chars)

No

No

The currency associated to the subscription value. Mandatory when you also set the Value.

AdditionalInfo

String (max length 255 chars)

No

No

Extra information that you can attach to a subscription, such as the source of the initial purchase.

NextRenewalPrice

numeric

No

No

The future costs that subscribers would incur when renewing subscriptions. Accompany it with NextRenewalPriceCurrency and CustomPriceBillingCyclesLeft.

NextRenewalPriceCurrency

String (max length 3 chars)

No

No

The currency associated with the subscription next renewal price value. Mandatory when you provide NextRenewalPrice.

CustomPriceBillingCyclesLeft

numeric

No

No

The number of billing cycles for which 2Checkout uses a custom renewal price you set up. Mandatory when you also provide NextRenewalPrice.

SubscriptionStartDate

datetime

No

No

Subscription start date. Format: yyyy-mm-dd hh:mm:ss. Default time zone is GMT + 2.

IdAffiliate

numeric

No

Yes

Unique affiliate identifier from the 2Checkout platform. Use the ID to commission a specific 2Checkout Network affiliate for subscription renewal charges. Possible values:

  • 0 – Removes the affiliate attached to a subscription. This causes 2Checkout to stop commissioning the affiliate for renewal charges.
  • 12345 – Assigns the subscription to the affiliates having the ID 12345.

When this column is missing or its corresponding values are empty, 2Checkout does not change the affiliates attached to the subscriptions.

FiscalCode string No Yes Business registration number (VAT ID/ ABN/ IRD/ GST)
Test numeric No Yes Available only for eStore subscriptions. Use 1 to import a test subscription. Exclude the parameter or set the value to 0 to import regular subscriptions. Test subscriptions enable you to try out flows like manual and auto renewal, and upgrade. Check out the documentation for additional details.
CardNumber numeric No Yes

Available only for test subscriptions. Only 2Checkout test credit cards can be used. Check here the list of credit cards that can be used for import.

Cardholder name is composed as FirstName + " " + LastName.

CardExpirationDate numeric No Yes Expiration date of the dummy credit card. Only future dates can be used. Format mmyy.

 

Workflow

  1. Contact 2Checkout Support with a request to start the migration process and follow through the compliance assessment process.
  2. Either create or have the third-party you’re working with build the subscription data CSV file.
  3. Upload the file to a designated SFTP account provided by 2Checkout.
  • Was this article helpful?