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

Dohtur: Redirected page to X-Cart:X-Payments Subscriptions and Installments

2014-02-26T12:12:10Z

Redirected page to X-Cart:X-Payments Subscriptions and Installments

Dohtur: /* Email notifications */

2014-02-26T11:35:34Z

‎Email notifications

Dohtur at 11:31, 26 February 2014

2014-02-26T11:31:58Z

Dohtur: /* Configuring the module */

2014-02-26T11:02:11Z

‎Configuring the module

Dohtur: /* Configuring the module */

2014-02-26T10:40:23Z

‎Configuring the module

Dohtur: /* Getting started with X-Payments Subscriptions and Installments */

2014-02-26T09:19:33Z

‎Getting started with X-Payments Subscriptions and Installments

Dohtur: /* Configuring the module */

2014-02-26T09:12:31Z

‎Configuring the module

Dohtur: /* Configuring the module */

2014-02-26T09:11:53Z

‎Configuring the module

Dohtur: /* Stopping/Re-starting a subscription */

2014-02-26T07:47:00Z

‎Stopping/Re-starting a subscription

Dohtur at 05:22, 26 February 2014

2014-02-26T05:22:56Z

← Older revision		Revision as of 12:12, 26 February 2014
Line 1:		Line 1:
		+	#REDIRECT [[X-Cart:X-Payments_Subscriptions_and_Installments]]
		+
	{{XC version\|version=4.4.5\|color=#FFB62F\|comment={{{1\|or above}}}}}		{{XC version\|version=4.4.5\|color=#FFB62F\|comment={{{1\|or above}}}}}

@@ Line 156: / Line 156: @@
 :[[File:XPsubscr_calendar.png|border]]<br /><br />
-==Email notifications==
+==Email notification templates==
 The module X-Payments Subscriptions and Installments enables some specific notification messages (see below). To adjust the look/contents of these messages, edit the respective templates.

@@ Line 159: / Line 159: @@
 The module X-Payments Subscriptions and Installments enables some specific notification messages (see below). To adjust the look/contents of these messages, edit the respective templates.
-For X-Cart 4.6.2, the following notification templates are available:
+Starting with the module version for X-Cart 4.6.2, the following notification templates are available:
 : 1. Notification about the change of subscription status (separate for customer and for orders department):

@@ Line 59: / Line 59: @@
 # 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''': If the initial attempt to process a subscription payment is unsuccessful, the module will attempt to charge the customer's card again in a few days (The number of days is defined by the "How often to attempt rebills for an unsuccessful charge (in days)" setting below). The "'Number of rebill attempts for an unsuccessful charge" setting allows you to set the maximum number of times that your store must try to charge the customer's card after the initial attempt to process the subscription payment was unsuccessful.
+#* '''Number of rebill attempts for an unsuccessful charge''': Normally, the module will charge a subscription customer according to the schedule defined for their specific subscription. However, sometimes the processing of such payments may fail. In this case, the module will attempt to charge the customer's card again in a few days (The number of days is defined by the "How often to attempt rebills for an unsuccessful charge (in days)" setting below). The "'Number of rebill attempts for an unsuccessful charge" setting allows you to set the maximum number of times that your store must try to charge the customer's card after the initial attempt to process the subscription payment was unsuccessful. If this number is exceeded, the module will stop the subscription and send an email notification both to the customer and the store's orders department.
 #* '''How often to attempt rebills for an unsuccessful charge (in days)''': Specify how often your store must attempt to charge the customer's card again if the initial attempt to process the subscription payment was unsuccessful. For example, if you set this value to "3", your store will attempt to charge the customer's card once every three days - until the payment can be processed successfully.
-#* '''Notify the customer of the upcoming payment X days in advance''': The module can notify subscription customers about upcoming subscription payments. This setting allows you to specify how many days in advance the store must notify customers with active subscriptions of the next subscription payment.
+#* '''Notify the customer of the upcoming payment X days in advance''': The module can notify subscription customers that they will soon be charged for their subscription a few days before the subscription payment is actually billed to their account. The setting "Notify the customer of the upcoming payment X days in advance" allows you to specify how many days in advance the store must send a notification of the upcoming subscription payment to customers with active subscriptions.
 # Click '''Apply changes'''.<br />This is it. Now your module has been configured.

@@ Line 59: / Line 59: @@
 # 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 to set the maximum number of times that your store must try to charge the customer's card after the initial attempt to process the subscription payment was unsuccessful.
+#* '''Number of rebill attempts for an unsuccessful charge''': If the initial attempt to process a subscription payment is unsuccessful, the module will attempt to charge the customer's card again in a few days (The number of days is defined by the "How often to attempt rebills for an unsuccessful charge (in days)" setting below). The "'Number of rebill attempts for an unsuccessful charge" setting allows you to set the maximum number of times that your store must try to charge the customer's card after the initial attempt to process the subscription payment was unsuccessful.
 #* '''How often to attempt rebills for an unsuccessful charge (in days)''': Specify how often your store must attempt to charge the customer's card again if the initial attempt to process the subscription payment was unsuccessful. For example, if you set this value to "3", your store will attempt to charge the customer's card once every three days - until the payment can be processed successfully.
-#* '''Notify the customer of the upcoming payment X days in advance''': Specify how many days in advance the store must notify customers with active subscriptions of the next subscription payment.
+#* '''Notify the customer of the upcoming payment X days in advance''': The module can notify subscription customers about upcoming subscription payments. This setting allows you to specify how many days in advance the store must notify customers with active subscriptions of the next subscription payment.
 # Click '''Apply changes'''.<br />This is it. Now your module has been configured.

@@ Line 22: / Line 22: @@
 # Ensure that your system meets the module system requirements, then install and enable the module:
 #*[[Draft:X-Cart:X-Payments_Subscriptions_and_Installments_module_installation|X-Payments Subscriptions and Installments module installation]]
-# Configure the module:
+# Configure your server to periodically run the xps_cron.php script (required for correct operation of the module):
 #* [[Draft:X-Cart:X-Payments_Subscriptions_and_Installments#Configuring the module|X-Payments Subscriptions and Installments: Configuring the module]]
 Once these steps are completed, the module is ready to use.
+<br /><br />
 Instructions for using the X-Payments Subscriptions module are available here:
 :* [[Draft:X-Cart:X-Payments_Subscriptions_and_Installments#Admin/Provider experience|Admin/Provider experience]]

@@ Line 62: / Line 62: @@
 # Click '''Apply changes'''.<br />This is it. Now your module has been configured.
-===Running the script xps_cron.php===
+==Running the script xps_cron.php==
 The module X-Payments Subscriptions and Installments provides a script <u>xps_cron.php</u> (for X-Cart versions 4.6.1 and earlier - <u>cron_subscriptions.php</u>) that must be periodically executed from the command line for correct operation of the module.

@@ Line 91: / Line 91: @@
 At any moment you can stop re-bills for any subscription. To do so, follow these steps:
 # Open the details of any order pertaining to the subscription that needs to be stopped.
-# In the "Subscription Info" section, click the '''Stop''' button below the subscription status:<br />[[File:XPsubscr_stop_subscription.png|border]]<br /><br />A confirmation popup appears.
+# In the "Subscription Info" section, click the '''Stop''' button below the subscription status:<br />[[File:XPsubscr_stop_subscription.png|border]]<br /><br />
-# Confirm your decision to stop the subscription.
+Once you have stopped the subscription, the respective billing task will be deleted from cron job processing; the '''Stop''' button will change to '''Re-launch'''.<br /><br />
 To restart a previously stopped subscription, use the '''Re-launch''' button:
 ::[[File:XPsubscr_relaunch_subscription.png|border]]<br /><br />

← Older revision		Revision as of 05:22, 26 February 2014
Line 1:		Line 1:
		+	{{XC version\|version=4.4.5\|color=#FFB62F\|comment={{{1\|or above}}}}}
		+
	==Overview==		==Overview==
	X-Cart's X-Payments Subscriptions and Installments module is a full-featured recurring billing solution for stores based on X-Cart. If you are considering a subscription model for some or all of your products or services, the X-Payments Subscriptions and Installments module is the way to go:		X-Cart's X-Payments Subscriptions and Installments module is a full-featured recurring billing solution for stores based on X-Cart. If you are considering a subscription model for some or all of your products or services, the X-Payments Subscriptions and Installments module is the way to go: