Important Release Security fixes for EasySocial 3.2.5 is now available 🚨Update Now!!

Legacy Documentation


91 Articles

Bookmarked Articles

No bookmarks yet
  1. Documentation
  2. Legacy Documentation
  3. Using Tokens

Using Tokens

Using Tokens

PayPlans tokens are relevant for the current object. This KB describes functionality(ies) of all PayPlans available tokens as follows-

[[CONFIG_SITE_NAME]]: Displays the name of the website

[[CONFIG_COMPANY_NAME]]: Displays the name of your company

[[CONFIG_COMPANY_ADDRESS]]: Displays address of the corresponding company

[[CONFIG_COMPANY_CITY_COUNTRY]]: Displays city and country of the company

[[CONFIG_COMPANY_PHONE]]: Displays phone number of the company

[[CONFIG_SITE_URL]]: Displays URL (Uniform Resource Locator) of the current website.

[[CONFIG_PLAN_RENEW_URL]]: Displays URL for renewal of a certain plan

[[CONFIG_DASHBOARD_URL]]: Displays URL of the dashboard page at the front-end

[[CONFIG_ORDER_DETAILS_URL]]: Displays the URL of the details of the order

[[PLAN_PLAN_ID]]: Displays the key of the plan

[[PLAN_TITLE]]: Displays title of the plan

[[PLAN_DESCRIPTION]]: Displays description of the plan

[[PLAN_DETAILS_EXPIRATIONTYPE]]: Displays type (fixed, recurring or forever) of expiration of the subscription

[[PLAN_DETAILS_EXPIRATION]]: Displays the time at which the subscription expires

[[PLAN_DETAILS_RECURRENCE_COUNT]]: Displays the count of the no. of recurrences allowed for the payment

[[PLAN_DETAILS_TRIAL_PRICE_1]]: Displays first trial price of the plan

[[PLAN_DETAILS_TRIAL_TIME_1]]: Displays time period of the first trial of the plan

[[PLAN_DETAILS_TRIAL_PRICE_2]]: Displays second trial price of the plan

[[PLAN_DETAILS_TRIAL_TIME_2]]: Displays time period of the second trial of the plan

[[PLAN_DETAILS_PRICE]]: Displays actual price of the plan

[[PLAN_DETAILS_CURRENCY]]: Displays currency of the cost of the plan

[[SUBSCRIPTION_SUBSCRIPTION_ID]]: Displays subscription key

[[SUBSCRIPTION_ORDER_ID]]: Displays order key in the additional details

[[SUBSCRIPTION_USER_ID]]: Displays id of the user

[[SUBSCRIPTION_PLAN_ID]]: Displays ID of the plan

[[SUBSCRIPTION_STATUS]]: Displays status of the subscription

[[SUBSCRIPTION_TOTAL]]: Displays total amount of the subscription

[[SUBSCRIPTION_SUBSCRIPTION_DATE]]: Displays date of the activation of the subscription

[[SUBSCRIPTION_EXPIRATION_DATE]]: Displays the date of expiration of the subscription

[[SUBSCRIPTION_CANCEL_DATE]]: Displays the date of cancellation of the subscription

[[ORDER_ORDER_ID]]: Displays key of the created order

[[ORDER_BUYER_ID]]: Displays id of the buyer of the order

[[ORDER_TOTAL]]: Displays total payable amount of the order

[[ORDER_CURRENCY]]: Displays currency of the amount of the order

[[ORDER_STATUS]]: Displays current status (confirmed, complete, expired, hold, none) of the order

[[ORDER_CREATED_DATE]]: Displays the date of creation of the order

[[ORDER_PARAMS_FIRST_INVOICE_ID]]: Displays key of the first invoice generated

[[ORDER_PARAMS_LAST_MASTER_INVOICE_ID]]: Displays last master key of the invoice generated

[[PAYMENT_PAYMENT_ID]]: Displays key of the payment

[[PAYMENT_USER_ID]]: Displays id of the user

[[PAYMENT_INVOICE_ID]]: Displays key of the invoice of the payment

[[PAYMENT_APP_ID]]: Displays id of the app used

[[PAYMENT_CREATED_DATE]]: Displays the date of creation of the payment

[[PAYMENT_MODIFIED_DATE]]: Displays the date of modification of the payment

[[INVOICE_INVOICE_ID]]: Displays the alphanumeric random key of the invoice

[[INVOICE_OBJECT_ID]]: Displays the numeric id of the invoice object

[[INVOICE_OBJECT_TYPE]]: Displays the type of object of the invoice

[[INVOICE_USER_ID]]: Displays id of the user

[[INVOICE_SUBTOTAL]]: Displays the subtotal on the invoice

[[INVOICE_TOTAL]]: Displays the total amount in the invoice

[[INVOICE_CURRENCY]]: Displays the currency of amount in the invoice

[[INVOICE_COUNTER]]: Displays the counter number of the invoice

[[INVOICE_CREATED_DATE]]: Displays the date of creation of the invoice

[[INVOICE_MODIFIED_DATE]]: Displays the date of modification of the invoice

[[INVOICE_STATUS]]: Displays the current status (paid, confirmed, refunded, none) of the invoice

[[INVOICE_INVOICE_SCREEN_LINK]]: Displays the URL link of the invoice

[[TRANSACTION_TRANSACTION_ID]]: Displays key of the transaction

[[TRANSACTION_INVOICE_ID]]: Displays key of invoice on the transaction

[[TRANSACTION_CURRENT_INVOICE_ID]]: Displays current key of the invoice

[[TRANSACTION_USER_ID]]: Displays the user’s id for the transaction

[[TRANSACTION_PAYMENT_ID]]: Displays the payment key for the transaction

[[TRANSACTION_AMOUNT]]: Displays the amount calculated for the transaction

[[TRANSACTION_CREATED_DATE]]: Displays the date of creation of the transaction

[[USER_USER_ID]]: Displays the user’s id

[[USER_REALNAME]]: Displays the actual name of the user as mentioned in the “Name” field

[[USER_USERNAME]]: Displays the user’s username

[[USER_EMAIL]]: Displays email_id of the user

[[USER_USERTYPE]]: Displays the type of Joomla! user assigned to the currently logged-in user

[[USER_ADDRESS]]: Displays the address of the user

[[USER_STATE]]: Displays address of the user

[[USER_CITY]]: Displays city of the user

[[USER_COUNTRY]]: Displays country of the user

[[USER_ZIPCODE]]: Displays Zipcode of the user’s location

[[USER_PREFERENCE_BUSINESS_PURPOSE]]: Displays the preferred business purpose of the user

[[USER_PREFERENCE_SHIPPING_ADDRESS]]: Displays the preferred shipping address of the user

[[USER_PREFERENCE_BUSINESS_ADDRESS]]: Displays preferred business address of the user

[[USER_PREFERENCE_TIN]]: Displays Tax Identification Number of the user

[[USER_PREFERENCE_BUSINESS_NAME]]: Displays preferred business name of the user

[[USER_WALLET_BALANCE]]: Displays current balance available in the user’s wallet

This article is separated into multiple sections as follow:
Subscribe for product updates & promotions