LCN Parameters

Possible values:

• 1 for test subscriptions
• 0 for 'real' subscriptions

Reveals the author of subscription modifications. Possible values:

• CUSTOMER
• VENDOR
• SYSTEM

Possible values:

• REGULAR
• TRIAL

Subscription status.

• 1 for Disabled
• 0 for Enabled

The renewal license type

• 1 for recurring billing
• 0 for renewal that requires manual input from the customer

This parameter indicates whether the subscription is evergreen (lifetime)

• 1 - lifetime
• 0 - for subscriptions with a recurring billing cycle

This parameter indicates the current, total number of billing cycles for a subscription since its creation/import, reflecting the number of renewals, but counting from the first payment made, equivalent with the initial billing cycle. For imported subscriptions, the first billing cycle starts immediately after import.

The default value is 1, for the initial billing. A subscription renewed once enters the second billing cycle, and the value of the parameter changes to 2. Similarly, the value increases to 3 for the third billing cycle, 4 for the fourth, and so on. It is the correspondent of the BILLING_CYCLES option in the LCN configuration page. Available only for subscriptions for which you configure a contract.

Possible values:

• Empty - eCommerce order
• Partner code

The status of the subscription. Possible values:

• PENDING_ACTIVATION (subscription with delayed start date)
• ACTIVE (for licenses/subscriptions still in use)
• CANCELED (for canceled licenses/subscriptions)
• EXPIRED (for expired licenses/subscriptions)
• PASTDUE (for licenses/subscriptions in the grace period)
• PAUSED (for licenses/subscriptions that were paused) 

• 1 - subscriptions/licenses expired. 
• 0 - active subscriptions/licenses suffered modifications.

Designed to differentiate subscriptions leveraging usage pricing options groups from those without a metered cost component.

• PREPAID - subscription cost governed only by pricing options groups of the following type: Radio, Dropdown, Checkbox, and Scale (but without a metered cost component (usage scale pricing)).

• POSTPAID - subscription cost includes a metered cost component (usage scale pricing).

The date resulting from adding the Usage Billing Interval defined to the expiration deadline of the subscription.

For subscriptions with the automatic renewal system enabled and for which you uploaded usage data, the USAGE_BILLING_DATE represents the moment when 2Checkout attempts to automatically renew the subscription and charge the customer.

The status of usage data upload and processing.

• UNREPORTED
• REPORTED
• PAID

Indicates the action performed at the end of the subscription contract. Possible actions: subscription automatic renewal or expiration.

Possible values:

• CANCEL
• RESTART
• NONE

Calculated HMAC_MD5 signature based on the sent LCN fields and the secret key

(Note: This parameter won't be used anymore for LCN validation as of 15th of August, 2024.)

The reason why LCN was dispatched. Value depends on the change made on the license.

Possible values:

• LICENCE_CHANGE - Licence change
• LICENCE_EXPIRATION - Licence expiration
•  LICENCE_PASTDUE - Licence past due 
• LICENCE_CC_CHANGE - Licence payment method changes
• LICENCE_IMPORTED - Licences changed via import
• LICENCE_CPC_ACCEPTED-  Licences when a Churn Prevention Campaign was accepted
• SCHEDULED_FOR_CANCELATION_ON_DEMAND - Scheduled cancellation event has been registered 
•  REVERT_CANCELATION_ON_DEMAND - Scheduled cancellation event has been reverted
• CANCELATION_ON_DEMAND - Scheduled cancellation actually has taken place
• LICENCE_PENDING_ACTIVATION - Licence pending activation
• LICENCE_GP_CHANGE - Licence grace period change

Possible values: 

• 1 - for trial subscriptions
• 0 - for regular subscriptions

Array with the names of all the price options used on the product generating the license

For usage scale pricing option groups, 2Checkout returns the name of the pricing options as well as the number of units of metered resources consumed by the customer. Format: 'PricingOptionsGroupName: NumberOfUnitsConsumed', for example 'GBs: 100'.

Array with unique codes set up for the active pricing option groups of the product generating the license.

In the case of usage scale pricing options groups, 2Checkout returns both the unique code of the group as well as the number of units of metered resources consumed by the customer. Format: 'UniqueCode: NumberOfUnitsConsumed', for example 'metered GBs: 100'.

Array with all price operators corresponding to each active price option, of the product generating the license.

Possible values:

• ADD

• SUBTRACT

Designed to differentiate usage pricing options groups from non-usage pricing options groups.

Possible values:

• PREPAID - for orders involving products with pricing options groups of the following type: Radio, Dropdown, Checkbox, and Scale (but without a metered cost component (usage scale pricing)). 
• POSTPAID - for orders involving products with a metered cost component (usage scale pricing).

Array with operators showing the impact of the active pricing option on the subscription.

Possible values:

• ADD
• SUBTRACT
• NONE
• RECURRING

Array with the values (number of months) which are the impact of the active pricing options.

When LCN_LICENSE_OPTIONS_IMPACT_SUBSCRIPTION returns “NONE” or “RECURRING”, LCN_LICENSE_OPTIONS_IMPACT_SUBSCRIPTION_VALUE will return 0.