Difference between revisions of "Draft:X-Cart:X-Payments Subscriptions and Installments"

From X-Cart 4 Classic
Jump to: navigation, search
m (Customer experience)
m (Activating and deactivating the module)
Line 34: Line 34:
 
# Locate the entry for the X-Payments Subscriptions and Installments module and select the respective check box on the left.  
 
# Locate the entry for the X-Payments Subscriptions and Installments module and select the respective check box on the left.  
 
# Depending on the version of X-Cart you are using, you may need to apply the change by clicking the '''Apply changes''' button. The module will be enabled.
 
# Depending on the version of X-Cart you are using, you may need to apply the change by clicking the '''Apply changes''' button. The module will be enabled.
 +
 +
==Configuring the module==
 +
 +
After the module has been installed and enabled, it needs to be configured.
 +
 +
'''To configure the module''':
 +
 +
# In the Modules section of your store's Admin area (Settings menu->Modules), locate the entry for 'X-Payments Subscriptions and Installments' module and click the Configure link next to it:<br />[[File:XPsubscr_configure.png|border]]<br /><br />The X-Payments Subscriptions and Installments module configuration page opens:<br />[[File:XPsubscr_settings.png|border]]<br /><br />
 +
# Adjust the module configuration settings:
 +
#* '''Number of rebill attempts for an unsuccessful charge''': Use this
 +
#* '''How often to attempt rebills for an unsuccessful charge (in days)''': Specify
 +
#* '''Notify the customer of the upcoming payment X days in advance''':
 +
# Click '''Apply changes'''.<br />This is it. Now your module has been configured.
  
 
==Admin experience==
 
==Admin experience==

Revision as of 00:50, 11 February 2014

Overview

System requirements and installation

See X-Payments Subscriptions and Installments module installation


Getting started

To begin using the X-Payments Subscriptions and Installments module on your system, use the following guidelines:

  1. Install and enable the module.
  2. Configure the module.

Once these steps are completed, the module is ready to use. Instructions for using the X-Payments Subscriptions module are available here:

Activating and deactivating the module

It is possible to temporarily disable (deactivate) the installed X-Payments Subscriptions and Installments module. Deactivation stops the module from operation, but it does not remove any settings you made to the module configuration nor clear any data that was generated during the period that the module was in operation. If you wish to completely remove all the data related to using the module, you need to uninstall it. See X-Payments Subscriptions and Installments: Uninstallation for more info.

To disable the module:

  1. Go to the Modules section of your store's Admin area (Settings menu->Modules).
  2. Locate the entry for the X-Payments Subscriptions and Installments module and unselect the respective check box on the left.
  3. Depending on the version of X-Cart you are using, you may need to apply the change by clicking the Apply changes button. The module will be disabled.

If the module X-Payments Subscriptions and Installments is installed, but not active, you can enable (activate) it.

To enable the module:

  1. Go to the Modules section of your store's Admin area (Settings menu->Modules). This opens the list of your store's installed modules.
  2. Locate the entry for the X-Payments Subscriptions and Installments module and select the respective check box on the left.
  3. Depending on the version of X-Cart you are using, you may need to apply the change by clicking the Apply changes button. The module will be enabled.

Configuring the module

After the module has been installed and enabled, it needs to be configured.

To configure the module:

  1. In the Modules section of your store's Admin area (Settings menu->Modules), locate the entry for 'X-Payments Subscriptions and Installments' module and click the Configure link next to it:
    XPsubscr configure.png

    The X-Payments Subscriptions and Installments module configuration page opens:
    XPsubscr settings.png

  2. Adjust the module configuration settings:
    • Number of rebill attempts for an unsuccessful charge: Use this
    • How often to attempt rebills for an unsuccessful charge (in days): Specify
    • Notify the customer of the upcoming payment X days in advance:
  3. Click Apply changes.
    This is it. Now your module has been configured.

Admin experience

Setting up a subscription product

XPsubscr product checkbox.png

XPsubscr product settings.png

Viewing/filtering subscription orders

Customer experience

Customer subscr list.png