Installation Guide ClickandBuy subscriptions for Ubercart

Version: Author: Date: Pages:

1.0 PayIntelligent GmbH 2010-03-31 11

Table of Content
1 2 Drupal Ubercart Modules ............................................................................................................................ 3 ClickandBuy subscription setting.................................................................................................................... 3 2.1 2.2 3 ClickandBuy Registration ....................................................................................................................... 3 ClickandBuy Settings .............................................................................................................................. 4

Products settings ............................................................................................................................................ 5 3.1 3.2 3.3 Product .................................................................................................................................................. 6 Create a ClickandBuy subscription ........................................................................................................ 6 Features ................................................................................................................................................. 9

Conditional actions ....................................................................................................................................... 10 4.1 4.2 4.3 4.4 4.5 Grant role on subscription ................................................................................................................... 10 Revoke role on subscription ................................................................................................................ 10 Recurring order renewal succeeded .................................................................................................... 11 Recurring order renewal ...................................................................................................................... 11 Recurring order renewal expired......................................................................................................... 11

2010 Payintelligent

Page 2/ 11

1 Drupal Ubercart Modules

For the ClickandBuy subscription module it is a precondition that you also install the additional below drupal modules.

ubercart-6.x-2.2 uc_recurring-6.x-2.x-dev uc_clickandbuy soapclient-6.x-1.0-beta2 token-6.x-1.12

Unzip the module .zip files and upload all files to your module folder where Drupal is installed. Sign in to your Drupal administration click Administer Site building > Modules and enable the above modules.

2 ClickandBuy subscription setting

2.1 ClickandBuy Registration
If you dont have a ClickandBuy Account click Administer Store administration Configuration Payment settings > About ClickandBuy subscription Register now to register a ClickandBuy account. After successful registration your ClickandBuy settings will be automatically set in your Drupal.

2010 Payintelligent

Page 3/ 11

2.2 ClickandBuy Settings

If you already have a ClickandBuy account fill the needed fields Seller ID and Transaction Manager password Administer Store administration Configuration Payment settings Payment methods ClickandBuy subscription settings.

2010 Payintelligent

Page 4/ 11

3 Products settings
We assume that you have setup correct products, pages and menus with the corresponding user roles for a membership.

To Setup the ClickandBuy Configuration in your product please edit the product under Administer Content management. If you don't have a product, create a new product Administer Content management Content.

2010 Payintelligent

Page 5/ 11

3.1 Product
Set the subscription price in the sell price field (product information area) and ensure that the feature Product and its derivatives are shippable is disabled.

3.2 Create a ClickandBuy subscription

Login into your ClickandBuy Merchant Account and click on Subscriptions -> [Add]

Enter a Name (e.g. Weekly Membership), Description (e.g. weekly) and an ExternalID name (e.g. id2), then click on [Save].

2010 Payintelligent

Page 6/ 11

Click on [Add fee] to configure a new subscription fee:

It is the subscription fee that defines and controls the offer price, duration, cancellation period and interval of recurring debits. The fee configuration also defines if a session based or transaction based subscription is used. It is possible to configure multiple fees for a subscription.. A typical scenario would be to offer a special price or trial offer for the first billing period (first fee) which will then revert to the normal price for the remainder of the subscription (second fee).

2010 Payintelligent

Page 7/ 11

The options to enter to create a fee are detailed as such: Field name
Name Information Price

Description
Enter here a name for the subscription fee (e.g. monthly subscription). Enter here information about the subscription (e.g. price per month). Enter here the price for the subscription period (same as in your drupal settings!)

Allow dynamic prices Transaction Type Success String Site

Enable the checkbox. Enable the checkbox. Needs to be set to redirect. Enter result=success. Set the domain you wish to associate the subscription to for your reporting.

Allow test credits Duration Allow dynamic period Number of billings

Do not activate this option. Sets the duration of payment interval (same as in drupal settings). Do not activate this option. Enter the number of invoices issued to the customer. All values are accepted here. If the radio button Endless is enabled, invoices will be issued until the customer cancels the subscription. In this case you should not enter a value.

Minimum amount of billings (optional) Cancellation time (optional) Allow First Trade Only

Enter the number of billing periods for which a customer is bound to a subscription before they may cancel. Enter here the minimum number of days of notice for cancelling a subscription. If this checkbox is enabled, the fee is charged only once for each customer. If the customer cancels the subscription and later signs up again, this fee is skipped. This feature can be used for an initial free trial period you want to grant only once per customer.

Content URL

Enter here the URL stated in your drupal admin settings at Administer

Store administration Configuration Payment settings Payment methods ClickandBuy subscription settings > ClickandBuy domain link.

2010 Payintelligent

Page 8/ 11

Change the subscription definition status via [Offer Administration-> Subscriptions-> Edit] by clicking on [Set Active]. Then click on [Add link] and retrieve the Subscription URL within the popup. This URL is needed to be entered in your drupal settings, see next chapter. For more information on the ClickandBuy transaction based subscriptions please check the manual at http://clickandbuy.com/WW_en/partners/manuals/clickandbuysubscription.html.

3.3 Features
Click Features Recurring fee edit

Fill the needed fields Subscription URL and External ID as defined against your ClickandBuy subscription definition.

2010 Payintelligent

Page 9/ 11

4 Conditional actions
4.1 Grant role on subscription
1. Go to Administer Store administration Conditional actions and click Add a predicate" 2. Enter a title such as "Grant role on subscription" 3. Select "ClickandBuy subscription event" as the trigger and click "Save predicate". 4. In the Conditions tab, select "Check the subscription event type" and click "Add condition" 5. Select "activated", "renewed" and "unblocked" from the event types list Click "Save changes" 6. In the Actions tab, select "Grant a role on an order" and click "Add action" 7. Select the role you wish to grant to the user from the dropdown list Click "Save changes"

4.2 Revoke role on subscription

1. Go to Administer Store administration Conditional actions 2. Click "Add a predicate" again Enter a title such as "Revoke role on subscription" 3. Select "ClickandBuy subscription event" as the trigger Click "Save predicate" 4. In the Conditions tab, select "Check the subscription event type" and click "Add condition" 5. Select "blocked" and "terminated" from the event types list Click "Save changes" 6. In the Actions tab, select "Revoke a role on an order" and click "Add action" 7. Select the role you wish to revoke from the user from the dropdown list Click "Save changes"

The selected role will now be granted to the user when the subscription is first activated, a renewal occurs, or the subscription is unblocked. The role will be removed again when the subscription is blocked or terminated.

2010 Payintelligent

Page 10/ 11

4.3 Recurring order renewal succeeded

1. Go to Administer Store administration Conditional actions 2. Click "Add a predicate" again Enter a title such as "Recurring order renewal succeeded" 3. Select " Recurring order renewal succeeded" as the trigger Click "Save predicate"

4.4 Recurring order renewal

4. Go to Administer Store administration Conditional actions 5. Click "Add a predicate" again Enter a title such as Recurring order renewal failed" 6. Select " Recurring order renewal failed" as the trigger Click "Save predicate"

4.5 Recurring order renewal expired

7. Go to Administer Store administration Conditional actions 8. Click "Add a predicate" again Enter a title such as Recurring order renewal expired" 9. Select " Recurring order renewal expired" as the trigger Click "Save predicate"

2010 Payintelligent

Page 11/ 11