Forgot your username?             Forgot your password?

Akeeba Subscriptions User's Guide

Nicholas K. Dionysopoulos

AkeebaBackup.com

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found on-line at http://www.gnu.org/licenses/fdl.html.

December 2013

Abstract

This book covers the use of the Akeeba Subscriptions component and its bundled modules and plugins for selling and managing subscriptions on your Joomla!™-powered web sites.


Table of Contents

1. Introduction and installation
Introducing Akeeba Subscriptions
Requirements and compatibility
2. Installation, updates and upgrades
Installing Akeeba Subscriptions
Installing or manually updating the component and language files
Upload and install.
Manual installation
Automatic updates
Requesting support and reporting bugs
Uninstallation
3. Initial set-up and usage
How subscriptions work and Quick Start
Configuration options
Subscription Level Groups
Subscription Levels
Tax Rules
Upgrade Rules
Subscription Level Relations
E-mail templates
Coupons
Coupons API
Subscriptions management
Affiliates management
Front-end items
Importing data
Importing from other components
Importing from CSV
Custom fields
Accessing custom fields data
Localising (translating) custom fields' labels and options
Integrated invoicing
Invoice Templates
Invoice management
Invoices as signed PDF files
Reports
Customising Akeeba Subscriptions
Customising the front-end layout
Customising emails
Message variables for subscription level messages and emails
4. Payment plugins
2Checkout Standard Purchase Routine
2Checkout Standard Purchase Routine (with recurring support)
None
Off-line
PayMill
Paypal
Paypal Payments Pro
Paypal Payments Pro (Express Checkout)
Skrill
Stripe
VivaPayments
5. Integration plugins
Joomla! User Groups Integration
Joomla! User Profile Sync
Automatic Country and City fill
Custom SQL scripts
Intellectual Property integration
Google Analytics Commerce integration
Akeeba Ticket System credits integration
Automatic content publishing
Slave subscriptions
6. Miscellaneous plugins
Subscription expiration control
Subscription expiration notification
Subscription emails
Administrator emails
Content restriction
Timed content release
The Akeeba Subscriptions Link (aslink) plugin
Agree to Terms of Service
ReCAPTCHA integration
User Registration Redirection to Akeeba Subscriptions
The logout plugins
7. Scheduling information
Activating the scheduling URL
Using the scheduling URL with CRON jobs
The CRON URL
Scheduling the housekeeping
8. Akeeba Subscriptions' modules
List of active subscriptions
List subscription levels
9. Developers' information
The "akeebasubs" plugin events
onAKSubscriptionChange
onAKUserRefresh
onSubscriptionFormRender
onSubscriptionFormRenderPerSubFields
onValidate
onValidatePerSubscription
onSubscriptionLevelFormRender
onAKUserGetData
onAKUserSaveData
onCancelMessage
onOrderMessage
The "akpayment" plugin events
onAKPaymentGetIdentity
onAKPaymentNew
onAKPaymentCallback