Description
-----------
This module provides API integration with Recurly.com, a hosted subscription
management service. For more information about the project, see the project page
at http://drupal.org/project/recurly.

Requirements
------------
Drupal 7.x
Libraries API

Installation
------------

- Download the Recurly PHP library from
  https://github.com/recurly/recurly-client-php and place it in
  sites/all/libraries so that "recurly.php" is located at
  sites/all/libraries/recurly/lib/recurly.php.
- If using the Recurly.js module, also download the Recurly.js library from
  https://github.com/recurly/recurly-js and place it in libraries so that
  "recurly.js" is located at sites/all/libraries/recurly-js/build/recurly.js.
- Log into your Recurly.com account and visit the "API Credentials" page. Copy
  the values for API Key, Private Key (generate if needed), and Subdomain and
  paste them into the module configuration under admin/config/services/recurly.
- While on the Recurly settings page, copy the full URL from the description of
  the "Listener URL key" field. It should be something like:
  "https://example.com/recurly/listener/QVDtH2CR". Use an HTTPS URL if
  available. Take this full URL and paste it into the Recurly.com setttings for
  "Push Notifications".

By default, the Recurly module will provide built-in pages for managing
subscriptions on a one-subscription-per-user basis. You may also enable the
Recurly.js module *OR* the Recurly Managed Pages module to allow users to update
their billing information securely. If you're using a more complicated
subscription system, you should look into the Commerce Recurly module (not
included as part of the main Recurly package).

While this module provides the ability to create, update and cancel
subscriptions, it does *not* provide any built-in way to perform actions when
a subscription is purchased (such as granting a user a role) or perform any
actions when a subscription expires (such as blocking a user account). Currently
performing a response to an action requires custom coding through
hook_recurly_process_push_notification(). See the recurly.api.php file for more
information on that hook.

Account Codes and Recurly E-mails
---------------------------------
When creating new accounts in Recurly.com, the Drupal Recurly module will use
a pattern of [entity_type]-[entity_id] to generate Recurly account codes. That
is a Drupal user account with UID #1 would be assigned the Recurly account code
"user-1". However this mapping between the Recurly "account_code" and Drupal's
entities can be arbitrary. Any mapping desired can be imported into the
"recurly_account" database table to bind any account_code to a Drupal ID.

If using the built-in pages for managing subscriptions, a user's typical
subscription page will be located at user/[uid]/subscription. However within
Recurly.com, you only have the "account_code" to work with when configuring
e-mails. To redirect to a users subscription page on your Drupal site, you
would use a URL such as http://example.com/manage-subscription/{{account_code}}.
The Recurly module will redirect the account from the account code to
http://example.com/user/[uid]/subscription.

Support
-------
Please use the issue queue for filing bugs with this module at
http://drupal.org/project/issues/recurly?categories=All

WE DO NOT PROVIDE SUPPORT ON CUSTOM CODING. Please use the issue queue for
issues that are believed to be bugs or for requesting features.