Welcome

Configuring PayPlans's Settings

Read through these documentation and start building your awesome site in minutes. PayPlans configuration process will be divided into 4 major parts; Settings, Customization, Import Data and Migrate Logs.

Settings

Lets start familiarizing with the settings. Navigate to PayPlans > Configuration > Settings. Under the setting's tab, you will see 4 sections; Features, Localization, Advanced, Expert and Setup-Checklist.

Settings

Features

Feature

  • Registration Integration
    PayPlans is integrated with these registration plugins viz; Quick, JomSocial, JFBConnect, Community Builder, Joomla Registration, JFacebook and Ad-Agency. Quick registration is PayPlans registration process which requires only username, password and user's mail id registration. Choose any of these processes which you want to use for registration of users. (Make sure respective plugin is enabled)

  • Block Non-Subscribers
    If it is set to Yes then PayPlans will restrict all those users who don't have any valid subscription.
    By default it is set to Yes.

  • Enable Plan Groups
    By enabling this option, you can group your available plans. If it is set to Yes then a new tab Groups will be added. Under this tab you can view list of the groups of the plans you have created.
    By default, it is set to No.

  • Wallet Recharge Allowed
    If it is set to Yes then it allows the users to recharge their wallet with some amount, for future use.
    By default it is set to No.

    Wallet Recharge Allowed

    This parameter is not available onwards PayPlans 3.2, as wallet was removed.
  • Enable Discount
    If it is set to Yes then only discount functionality will work, otherwise option for applying discount doesn’t exist.
    By default it is set to Yes.

Localization

Localization

  • Date Format
    By using this option, you can select the date format in which the date will be shown. You can also enter any valid date format other than the given formats.

  • Currency
    Here, you can select currency to be used for payment.

  • Show currency as
    Here, you can choose one of these forms: Full Name, ISO Code and Symbol, in which the selected currency should be displayed.

  • Show Currency At
    Here, you can choose the position of currency before/after price as per your requirement.

  • Amount Decimal Separator
    Here, you can choose the separator used in amount to separate decimal values.

  • Digits After Decimal
    Here, you can select the number of decimal digits to be shown with price.

Advance

This is an advanced settings. You shouldn't change any of these settings unless advised to or only if necessary or you know what you're doing. Otherwise, it is advised to leave it to default for normal use.

Advanced

  • Maximum allowed discount(in %)
    By using this option, you can set the maximum percentage of discount that can be applied on a single invoice. User can’t get discount amount more than the mentioned percentage of invoices’ total amount.
    By default it is set to 50%.

  • Use Https (SSL)
    Set it to Yes, if you want secure URL for Payment system.
    By default it is set to No.

    Use Https (SSL)

    You must have SSL certificate before enabling this feature. Else, no changes will take place regarding the setting explained above.
  • Enable Micro-Subscription
    Set it to Yes, if you want to create membership plans which can expire in a matter of hours or minutes.
    By default it is set to No.

  • Display Existing Subscribed Plans
    If it is set to No, then users can’t see their subscribed plans and can't re-subscribe already subscribed plans.
    By default it is set to Yes.

  • Allow Clubbing Of Discounts
    If set to No then discount can be applied only once. If set to Yes, then more than one discount can be clubbed with each other as per their individual setting. (Applicable only on discount created using prodiscount plugin)

  • Utilize Wallet For Payment
    If it is set to Yes, then available amount of wallet is utilized for payment.
    By default, it is set to No.

    Utilize Wallet For Payment

    This parameter is not available onwards PayPlans 3.2, as wallet was removed.
  • Utilize Wallet For Recurring Payment
    If it is set to Yes, then available amount of wallet is utilized for each recurring payments. Wallet amount is considered as pre-paid amount in this case.

    Utilize Wallet For Recurring Payment

    This parameter is not available onwards PayPlans 3.2, as wallet was removed.

Expert

This is an advanced settings. You shouldn't change any of these settings unless advised to or only if necessary or you know what you're doing. Otherwise, it is advised to leave it to default for normal use.

Expert

  • Cron Frequency
    Here you can set the time interval. On each time interval PayPlans cron will execute.
    You can set one of these four options: Lowest(1 hour), Low (1/2 hour), Normal (15 minutes) and High (5 minutes). If you have set the Micro Subscription to Yes then it will consider these timings Lowest(12 minutes), Low (6 minutes), Normal (3 minutes), High (1 minutes).

  • Encryption Key
    This key is used for generating non-predictable order, subscription, invoice, payment and transaction keys. Special characters are not allowed in Encyption Key.

    DO NOT change the Encription Key if you have recurring payments. Otherwise, all your upcoming recurring payments will be failed.
  • Block Logging
    You can block logging for the selected objects. After setting block logging objects, logs will not get created for the those objects.

  • Use JQuery
    Set it to No, if you don't want to load PayPlans jQuery library.
    By default it is set to Yes.

  • Use Minified JS
    Set it to Yes, if you want to minimize the loading time.
    Default value is Yes.

  • Use Bootstrap jquery
    Set to No, if you don't want to load PayPlans Bootstrap jQuery.
    Default value is Yes.

  • Use Bootstrap css
    Set to No, if you don't want to load PayPlans Bootstrap CSS.
    Default value is Yes.

  • Run Automatic Cron
    Set it to No, if you don't want to run payplans cron automatically.
    Default value is Yes.

  • Wait for payment
    In case of recurring, when subscription is about to expire and next payment is not received then before expiring the subscription, payplans will wait until the set time entered in this parameter.

  • Auto Delete Dummy Records
    If you want to delete the dummy records (subscription, invoice, transaction etc) which are not being used by customer from the specified period then here you can set the period. This option will delete only those records which have subscription status as No-Status.

  • Invoice Counter Format
    PayPlans assign a unique serial number to each paid invoice, you can set the format as you want.

    Value Format
    INV_1 INV_[[number]]
    RBSL_2014_1_INV RBSL_[[year]]_[[number]]_INV
    rbsl-monday-1 rbsl-[[day]]-[[number]]

    Available Tokens are as follows:
    [[number]] : Automatically incremental counter
    [[date]] : Date of invoice paid
    [[month]] : Month of invoice paid
    [[year]] : Year of invoice paid
    [[day]] : Day of invoice paid

Setup-Checklist

Setup-Checklist

There are some rules that are defined for proper working of PayPlans. The checklists which have not been cleaned yet, are shown highlighted in red colour. To know about any setup instruction hover your mouse over the setup rule, information will be visible in tooltip.

Points To Be Noted

  • You need to include [[number]] field necessarily otherwise, you will see same invoice number for same day.
  • Reassign to previous already paid invoice is not done, due to accounting reasons.
  • Serial number for already generated invoice can not be change.
  • Serial number for refunded invoice will not change.