Skip to main content
knowledgecenter.avangate.com

LCN triggers

Configure LCN triggers and message

Navigate to LCN settings under System settings. Select the events for which Avangate sends notifications from the list of options available under Notification Details.

LCN triggers

License Change Notification (LCN) provides automatic notifications for orders from the Avangate system, based on the following list of triggers you control:

LICENSE PROCESSING INFORMATION

Type / Length

FIRST_NAME

Customer first name

String/40

LAST_NAME

Customer last name

String/40

COMPANY

Company name

String/40

EMAIL

Customer email address

String/40

PHONE

Phone number

String/40

FAX

Fax number

String/40

COUNTRY

Country

String/50

STATE

State/County

String/30

CITY

City

String/30

ZIP

Zip code

String/20

ADDRESS

Customer address

String/100

LICENSE_CODE

System-generated, unique identifier for the subscriptions

String/50

EXPIRATION_DATE

The date when the subscription expires. For lifetime subscriptions the value is: 9999-12-31 23:59:59

String/20

DATE_UPDATED

The date when the Avangate system logs an update for a subscription.

String/20

AVANGATE_CUSTOMER_REFERENCE

Default customer numerical (integer) IDs generated automatically by the Avangate system. 

String/10

EXTERNAL_CUSTOMER_REFERENCE

Unique customer alphanumeric (string) identifiers that you control. 

String/250

TEST

Possible values:

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

String/1

CHANGED_BY

Reveals the author of subscription modifications. Possible values:

  • CUSTOMER
  • VENDOR
  • SYSTEM

String/8

LICENSE_TYPE

Possible values:

  • REGULAR
  • TRIAL

String/7

DISABLED

Subscription status.

  • 1 for Disabled
  • 0 for Enabled

String/1

RECURRING

The renewal license type

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

String/1

LICENSE_PRODUCT

Product ID

String/7

START_DATE

Date when you schedule the subscription to start.

String/20

PURCHASE_DATE

The initial date when a subscriber acquired the subscription.

String/20

LICENSE_LIFETIME

This parameter indicates whether the subscription is evergreen (lifetime).

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

String/1

BILLING_CYCLES

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.

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's the correspondent of the BILLING_CYCLES option in the LCN configuration page. Available only for subscriptions for which you configure a Contract.

String/2

CONTRACT_CYCLES

This parameter indicates the current subscription contract cycle. Default value is 1. For example, for a 12 month contract, the value of the CONTRACT_CYCLES is 1 for the first 12 months, 2 for the next 12 months after the contract is restarted, 3 for the following year, etc.

String/2

BILLING_CYCLES_LEFT

The number of billing cycles remaining until the contract restarts. Avangate counts down from the moment a subscription goes live. For example, the BILLING_CYCLES_LEFT value for a monthly subscription with a 12 month contract will be 11 the first month, 10 the second month, 9 the third, then 8, 7, 6, 5, 4, 3, 2, 1 and 0, before the contract restarts.

String/2

CURRENT_BILLING_CYCLE

This parameter indicates the current, total number of billing cycles of a subscription out of the duration of the current contract. For example, the CURRENT_BILLING_CYCLE value for a monthly subscription with a 12 month contract is 1 for the first month, 2 for second month, and so forth until the twelfth billing cycle when the value reaches 12. Following the restart of the contract, the CURRENT_BILLING_CYCLE value is also restarted, starting with 1 for the first month of the new contract, 2 for the second, etc.

String/2

NEXT_RENEWAL_PRICE Renewal price for the next billing cycle. Int
NEXT_RENEWAL_CURRENCY Renewal currency for the next billing cycle. String / 3
NEXT_RENEWAL_PRICE_TYPE GROSS/NET values depending whether the price includes taxes. String / 5

PARTNER_CODE

Possible values:

  • Empty - ecommerce order
  • Partner code

String/250

PSKU

Product SKU (stock keeping unit)

String/250

ACTIVATION_CODE

Sends out the last used activation code.

String/250

STATUS

The status of the subscription. Possible values:

  • PENDING_ACTIVATION (subscription with a delayed start date)
  • ACTIVE (for licenses/subscriptions still in use)
  • CANCELED (for cancelled licenses/subscriptions)
  • EXPIRED (for expired licenses/subscriptions)
  • PASTDUE (for licenses/subscriptions in the grace period)

String/18

EXPIRED

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

String/1

TIMEZONE_OFFSET

The time zone you selected or the default GMT+02:00 time zone of the Avangate system.

String/9

LICENSE_GRACE_PERIOD

The grace period impacting a subscription. Can have a numeric value (INT) representing the number of days sent as the grace period.

Int/2

LICENSE_BILLING_TYPE

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).

String/8

USAGE_BILLING_DATE

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 Avangate attempts to automatically renew the subscription and charge the customer.

String/20

USAGE_STATUS

The status of usage data upload and processing.

  • UNREPORTED
  • REPORTED
  • PAID

String/10

LATEST_REPORTED_USAGE_DATE

The most recent date when you uploaded usage data into the Avangate system for a subscription, preceding the renewal order, before subscribers pay for the metered resources consumed. Avangate resets counter after it renews the subscription.

String/20

ACTION_AFTER_CYCLES

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

  • CANCEL
  • RESTART
  • NONE

String/7

HASH

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

String/32