Recurly PHP Client

The Recurly PHP Client library is an open source library to interact with Recurly's subscription management from your PHP website. The library interacts with Recurly's REST API.

Note: This version uses Recurly API v2. There are substantial differences between this version of the client library and versions before 0.5.0. Please be careful when upgrading.

Requirements

The PHP library depends on PHP 5.3.0 (or higher) and libcurl compiled with OpenSSL support. Open up a phpinfo(); page and verify that under the curl section, there's a line that says something like:

libcurl/7.19.5 OpenSSL/0.9.8g zlib/1.2.3.3 libidn/1.15

Installation

Composer

If you're using Composer, you can simply add a dependency on recurly/recurly-client to your project's composer.json file. Here's an example of a dependency on 2.4:

{
    "require": {
        "recurly/recurly-client": "2.4.*"
    }
}

Git

If you already have git, the easiest way to download the Recurly PHP Client is with the git command:

git clone git://github.com/recurly/recurly-client-php.git /path/to/include/recurly

By Hand

Alternatively, you may download the PHP files in the lib/ directory and place them within your PHP project.

Initialization

Load the Recurly library files and set your subdomain and API Key globally:

<?php
require_once('./lib/recurly.php');

Recurly_Client::$subdomain = 'your-subdomain';
Recurly_Client::$apiKey = '012345678901234567890123456789ab';

API Documentation

Please see the Recurly API for more information.

Unit tests

You can run our unit tests by using Composer to install PHPUnit:

$ curl -s https://getcomposer.org/installer | php
$ php composer.phar install --dev
$ vendor/phpunit/phpunit/phpunit Tests/

Support

• https://support.recurly.com
• stackoverflow

Announcements

• @recurly
• Google Group Announcements

Contributing Guidelines

Please refer to CONTRIBUTING.md