Draft:X-Cart:X-Payments Subscriptions and Installments

Getting started

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

1. Ensure that your system meets the X-Payments Subscriptions module system requirements.
2. Install the module.
3. Enable the module.
4. 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:

• Using the X-Payments Subscriptions module (Admin area)
• Using the X-Payments Subscriptions module (Customer area)

X-Payments Subscriptions module system requirements

To be able to successfully install and use the X-Payments Subscriptions module, you need to have an installed working copy of X-Cart 4.1.x or later connected to an installed copy of X-Payments 2.0 or later by X-Cart’s built-in X-Payments Connector module.

Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the Environment info section of the Summary page in X-Cart Admin area.

Installing the X-Payments Subscriptions module

To install X-Payments Subscriptions:

1. Obtain a distribution package for the X-Payments Subscriptions module by downloading it from the File Area section of your X-Cart Account. The distribution package you need is contained in the archive file &&&-x.y.z.tgz where x, y and z are the version numbers of the module.
2. Copy the distribution package to the X-Cart root directory on your server or hosting account.
   • If you are using a Windows-based server, or a UNIX-based server without terminal access:

   a) Decompress the archive with the X-Payments Subscriptions module distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).

   b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.

   • If you are using a UNIX-based server with terminal access:

   a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.

   b) Decompress the package using the following command:

   tar -xzvf &&&-x.y.z.tgz

   Important: Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files may be overwritten!

3. In a web browser, run the installation script httр://<YOUR_XCART_DOMAIN>/install_xpayments_subscriptions.php replacing <YOUR_XCART_DOMAIN> with the actual domain name of your X-Cart store.
4. Enter the Auth code, accept the License Agreement and click Next.
5. The installation script patches the files and activates the module. Click Next to continue the installation.
   
   Note: If you are using a custom skin, you will need to patch it manually.

After the installation process has been completed, use the ADMINISTRATOR AREA link to log in to the Admin area.

5. Enabling the X-Payments Subscriptions module