For the complete documentation index, see llms.txt. This page is also available as Markdown.

Subscriber management and self-service

Overview

Customer (subscriber) accounts centralize billing, subscription, and transaction data from the 2Checkout system. A single customer (subscriber) can own and use one or multiple subscriptions.

Requirements

Customer accounts/IDs can be associated exclusively with subscriptions generated by the 2Checkout system for products configured using Control Panel. To define identifiers yourself, or to have IDs generated automatically, your customers need to use at least one subscription generated for a product with the renewal system enabled.

Subscription status can be active, past due (in the grace period), expired, or canceled.

Customer accounts are not supported for products with the renewal system disabled (without any subscriptions).

Subscription renewals

Subscription renewals will automatically be associated with the same customer using the initial subscription. A new customer account will not be generated for this scenario since the existing subscriber IDs are used.

Subscription renewal with a new product version

When the subscription for an older product being deprecated is renewed with the subscription of a newer product, it will automatically be associated with the same customer using the initial subscription. A new customer account will not be generated for this scenario since the existing customer IDs are used.

Upgrades

When the subscription for an older product is upgraded with the subscription of a newer product, it will automatically be associated with the same customer using the initial subscription. A new customer account will not be generated for this scenario since the existing customer IDs are used.

After a manual renewal or upgrade flow, any updates made by the shopper during the order process (e.g., adding/editing VAT ID, updating billing contact info) will now automatically update the customer details and/or end user details. This behavior also applies to API-triggered renewals/upgrades, ensuring consistency across platforms. The next automatic renewal will use the updated information. To activate this feature contact Merchant Support.

Customer scenarios
Existing Customer account is used
New Customer account is generated

New purchase

NO

YES

New purchase with new customer ID in the buy link

NO

YES

New purchase with existing customer ID in the buy link

YES

NO

Subscription renewal

YES

NO

Subscription renewal with the new product version

YES

NO

Upgrade creates a new subscription (disables the existing one)

YES

NO

Upgrade prolongs the subscription from the upgrade purchase date

YES

NO

The upgrade does not affect the original subscription duration

YES

NO

What's next

The What's next area provides an overview of upcoming automatic actions that the 2Checkout system will perform for the subscriptions under a customer account. It includes:

  • Next billing dates and amounts for subscriptions

  • Next renewal notification dates

Customer insight

This area reveals the date when the customer account was created.

Total customer value represents the total amount paid by a specific customer (converted to your default payout currency) for all subscriptions purchased for you as long as the orders that served to acquire them (including refunds) were finalized. Only revenue from Finalized orders is taken into consideration.

Orders with the same email address generate independent customers unless you specify the customer in the buy link.

Orders that do not generate subscriptions are not included in any customer value.

The all-time discount represents the total value of discounts offered to a specific customer. Again, only revenue from Finalized orders is taken into consideration.

The Customer insight area also provides details on all the subscriptions purchased by a customer along with information on their evolution in terms of renewals and upgrades.

The Upgrades section is displayed only if at least one of the products to which the subscriptions listed under a customer are associated has an upgrade configured.

Currency

The currency featured in the Customer insight area is the same as the default settlement currency for your account. In scenarios in which a customer purchased products from you in another supported currency, its value is converted into the default settlement currency.

Network Cross-selling

The Customer ID used in the buy link is limited to the customers of the vendor which owns the shopping cart. Subscriptions from third-party 2Checkout vendors will not be associated with the same customer ID as that of the main vendor.

Similarly, if your products are sold through network cross-selling by third-party 2Checkout vendors, customer IDs will be generated automatically by the system and will not be the same as the one set by the main vendor.

Customer Account Status

  • Active - a Customer Account is created when the first subscription for a product purchased by a customer becomes active. As long as at least one subscription associated with a customer remains active the Customer Account will also feature the Active status.

  • Trial - the Trial status is displayed for those Customer Accounts associated with customers using an active trial subscription.

  • Inactive - displayed when all subscriptions of a Customer Account are expired or canceled, or both.

Customer Accounts status
Text

Subscription status

Customer account status

Description

At least 1 Active subscription

Active

Customer account status is Active even if Trial and Canceled/Expired subscriptions exist for the customer, as long as there's at least one Active subscription. Customers with a single subscription featuring the Past due status (expired but in the grace period) are considered Active.

At least 1 Active Trial subscription

Trial

Customer account status is Trial if all Active subscriptions for this customer are trials, regardless of any Canceled/Expired subscriptions.

Only Expired / Canceled subscriptions

Inactive

All subscriptions associated with this Customer account are canceled, expired, or both.

Edit Customer Details

Click Edit at the bottom of the Customer billing details area to update the information associated with a specific account.

Select the checkbox next to the Update all customer subscriptions end-user details with these details option to also update the customer billing and end-user (delivery) details for all subscriptions governed by the same customer account.

The dedicated Customer area of Control Panel offers advanced search functionality designed to enable you to find particular or multiple customers. The underlying search technology has been optimized to deliver high performance and efficiency under an intuitive and easy to use interface.

You can only search for customers that have at least one subscription attached. Customers that were created via API (that are not tied to a subscription) cannot be found via the Control Panel Customers search.

Searches can be performed for:

  • 2Checkout customer IDs

  • External customer IDs

  • Customer name/company

  • Customer email address

  • Order reference

  • External reference / PO

  • 2Checkout Subscription Reference

  • Activation key

  • Partner invoice no.

  • SKU

The search supports partial queries for customer name/company; email address; 2Checkout Subscription Reference; partner invoice no.; SKU and activation key. When using 2Checkout customer IDs, external customer IDs, order reference, and external reference number the query term must match exactly.

You can filter results returned by the Customer search based on:

  • Customer status

  • Geographic regions

  • Customer country (the same country as specified in the billing details)

  • The product(s) purchased by customers

  • The date when the customer was created in the 2Checkout platform

  • The date when a product was upgraded

  • The dates when notifications were sent to customers

Export customer data

Customer data can be exported using the built-in functionality available alongside the search capabilities of the Merchant Control Panel.

Both customer details and subscription data are included in the CSV (comma-separated values) files that you can export. Essentially, information on single or multiple subscriptions acquired by the same customer is included in the CSV file.

For example, the exported CSV for the customer in the example below will feature two lines, one for each subscription purchased.

Optionally, you can also include the renewal price for customer licenses.

Workflow

Follow the steps below to generate a customer export file.

  1. Log in to the 2Checkout Control Panel.

  2. Go to Orders & customers > Customers.

  3. Use the existing filters to search for the customer you want to export data for.

  4. Click Export as CSV.

  5. Choose whether or not to include the renewal price for customer licenses.

  6. Click Export.

Export fields

The table below shows the fields included in customer exports.

Field name
Description

AvangateCustomerReference

System generated customer reference number in the 2Checkout system

ExternalCustomerReference

External customer reference that you control

CustomerFirstName

Billing first name

CustomerLastName

Billing last name

CustomerEmail

Billing email address

CustomerPhone

Customer phone number

CustomerFax

Customer fax number

CustomerAddress1

Customer address field

CustomerAddress2

Customer address field

CustomerCity

Customer city

CustomerZip

Customer zip code

CustomerState

Customer state

CustomerCountry

Customer country

CustomerCompany

Customer company name

LicenseUniqueId

Subscription ID that you control

IdProduct

Unique system generated product ID

PurchaseDate

Subscription purchase date

ExpirationDate

Subscription expiration date

ProductName

Product name

Quantity

Purchased quantity

FirstName

Delivery first name

LastName

Delivery last name

Email

Delivery email address

CommunicationLanguage

Language selected in the shopping cart upon purchase

ProductVersion

Purchased product version

ProductExtra

Company

Business customer company name

Phone

Business customer phone number

Fax

Business customer fax number

Address1

Delivery address field

Address2

Delivery address field

Zip

Delivery zip code

City

Delivery city

State

Delivery state

CountryCode

ISO country code

ProductOptions

Product pricing options

ActivationCode

Subscription activation code

IdPartner

Partner ID (if the order was placed by a reseller)

LicenseCode

Unique system generated subscription code

Refno

Order reference number

RenewalType

Subscription renewal type:

  • Auto

  • Manual

  • Lifetime

Status

Subscription status:

  • Active

  • Expired

URL

Merchant homepage URL

NextRenewalPrice

Renewal price for the next billing cycle

NextRenewalPriceCurrency

Currency of the next renewal price

TimeZone

Your account time zone

ShopperReferenceNumber

Shopper reference number for orders placed by resellers. Can be used in searches for customers, subscriptions and orders.

AdditionalInfo

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

PastDueDay(s)

Number of days passed since the subscription reached Past Due status

TestSubscription

Indicates test orders:

  • YES

  • NO

SubscriptionStartDate

Subscription generation start date

IdAffiliate

Unique affiliate identifier from the 2Checkout platform. 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.

CustomerValue

High level guideline for the overall business value of a customer. Calculated based on the completed orders placed by the customer. Test orders are not considered.

CustomerValueCurrency

Currency of the customer value.

Time zone support

Customer search supports time zone selection, enabling you to choose either the default 2Checkout time zone (GMT + 02:00) or a custom time zone that you control via Account settings / Edit system settings.

The time zone selected in the Customer search area controls the timestamps in which data on specific customer details pages is reported.

Maximum number of results

Customer search displays a maximum of 1,000 results.

When exporting, a maximum of 100,000 items can be included in a single CSV (comma separated values) file. If you'd like more results beyond the first 100,000 to be exported, simply modify date settings to export results in batches of 100,000.

Aggregate Customer Subscription

Use the subscription import functionality to aggregate multiple, disparate subscriptions under a single customer.

In scenarios in which different orders from the same shopper generate multiple Customer accounts, each with its own ExternalCustomerId, you have the option of moving all subscriptions under the same customer. This can happen when you don't provide the same ExternalCustomerId for orders placed by the same shopper, for example, and the 2Checkout system needs to generate the customer identifier automatically.

When using the import process to move subscriptions from under a customer account to another, the mandatory LicenseUniqueId field needs to be left empty if the subscription in question doesn't feature such an identifier. If you provide an identifier, the 2Checkout system will detect the item you're importing as a new subscription and add it to the targeted customer account, while leaving the subscription you intended to move, but which did not feature a LicenseUniqueId, under its existing customer account. When LicenseUniqueId is left empty, add a new field labeled LicenseCode to the CSV file, and enter the corresponding subscription reference identifier. The LicenseCode field can be added at the end of the mandatory fields, just after ExternalCustomerId for example. The presence of the LicenseCode field along with the subscription reference value will help the 2Checkout system identify the subscription you want to move from one customer account to another.

To aggregate subscriptions from multiple Customer accounts of the same shopper, you need to edit customer data saved in the 2Checkout system. When importing data for multiple subscriptions already in the 2Checkout system, specify the same ExternalCustomerId in the columns of the CSV file.

Imported subscriptions for which the ExternalCustomerId of an existing customer was provided will automatically be moved under the same account.

Subscription aggregation scenarios

Move a single subscription from Customer A to Customer B

Customer A features multiple subscriptions. Customer B must have an External Customer ID.

  • Create a CSV file and import Subscription A belonging to Customer A but specify the External Customer ID of Customer B in the document.

  • The 2Checkout system moves Subscription A from Customer A to Customer B. Customer A continues to be available.

Move multiple subscriptions from Customer A to Customer B

Customer B must have an External Customer ID.

  • Create a CSV file and import Subscription A, Subscription A1, and Subscription A belonging to Customer A but specify the External Customer ID of Customer B for all imported items in the document.

  • The 2Checkout system will move Subscription A from Customer A to Customer B. Customer A will continue to be available, as long as it still features at least one subscription.

Move all subscriptions from Customer A to Customer B

Customer B must have an External Customer ID.

  • Create a CSV file and import all subscriptions belonging to Customer A but specify the External Customer ID of Customer B for all imported items in the document.

  • The 2Checkout system will move all subscriptions from Customer A to Customer B. Customer A will no longer be accessible since it features no subscription, however, the account will be preserved in the 2Checkout system. As long as you know the External Customer ID of Customer A you will still be able to allow shoppers to place orders using this identifier in the Buy Links or to move subscriptions from different accounts under that of Customer A.

FAQ

What happens to subscriptions generated by the 2Checkout system before the new Customer Account functionality was available?

Individual Customer Accounts, each with its own unique numerical ID, will be created automatically for all subscriptions generated by the 2Checkout system. This is also valid for subscriptions imported in the 2Checkout system prior to the moment when this functionality went live.

Can the 2Checkout Customer ID be changed/deleted?

No. The unique 2Checkout Customer ID is locked and cannot be deleted or modified in any way.

Last updated

Was this helpful?