Recurly Build Status Gem Version

Recurly's Ruby client library is an interface to its REST API.

You can also look at rubydocs to see documentation on the classes and methods available.


Recurly is packaged as a Ruby gem. We recommend you install it with Bundler by adding the following line to your Gemfile:

gem 'recurly', '~> 2.16.0'

Recurly will automatically use Nokogiri (for a nice speed boost) if it's available and loaded in your app's environment.


If you're using Rails, you can generate an initializer with the following command:

$ rails g recurly:config

If you're not using Rails, use the following template:

Recurly.subdomain      = ENV['RECURLY_SUBDOMAIN']
Recurly.api_key        = ENV['RECURLY_API_KEY']

Configure the client library with your API credentials.

  • RECURLY_SUBDOMAIN should contain subdomain for your recurly account.
  • RECURLY_API_KEY is your "Private API Key" which can be found under "API Credentials" on the api_access admin page.

The default currency is USD. To override with a different code:

Recurly.default_currency = 'EUR' # Assign nil to disable the default entirely.

If you are using Recurly.js you can store "Public API Key" (which can be found under "API Credentials" on the api_access admin page):

Recurly.js.public_key = ENV['RECURLY_PUBLIC_API_KEY']

Then, in your Rails project you can create recurly_service.js.erb file and configure recurly.js with public key this way:

recurly.configure({ publicKey: '<%= Recurly.js.public_key %>'});

The client library currently uses a Net::HTTP adapter. If you need to configure the settings passed to Net::HTTP (e.g., an SSL certificates path or timeout lengths), make sure you assign them when initializing the library:

Recurly::API.net_http = {
  ca_path: "/etc/ssl/certs",
  open_timeout: 5, # 5 seconds (defaults to 60)
  read_timeout: 45 # 45 seconds (defaults to 60)

To see which keys are supported for this Hash, see the Attributes section of the Net::HTTP documentation for your ruby version.

Multi-Threaded Configuration

If you are using the client in a multi-threaded environment and require a different configuration per thread you can use the following within the thread's context:

  api_key: ENV['RECURLY_API_KEY'],
  default_currency: "US",
  private_key:  ENV['RECURLY_PUBLIC_API_KEY']

Any configuration items you do not include in the above config call will be defaulted to the standard configuration items. For example if you do not define default_currency then Recurly.default_currency will be used.

Supported Ruby Versions

We are currently supporting ruby language versions 2.2 and above. 1.9, 2.0, and 2.1 may still work but are not officially supported.

If you are still using one of these rubies, you should know that support for them ended in 2015 (1.9), 2016 (2.0), and 2017 (2.1) and continuing to use them is a security risk.

Nokogiri Support

For now, we are still running the tests on 2.0 and below but without nokogiri and only rexml. Nokogiri is no longer supported on 1.9 or 2.0 and has patched known vulnerabilities since dropping support. If you must run one of these rubies (this includes jruby1.7), you must use rexml and not nokogiri.


Instructions and examples are available on Recurly's documentation site.

Recurly's gem API is available here.



Developing for the Recurly gem is easy with Bundler.

Fork and clone the repository, cd into the directory, and, with a Ruby of your choice (1.9.3 or greater), set up your environment.

If you don't have Bundler installed, install it with the following command:

$ [sudo] gem install bundler

And bundle:

$ bundle --path=vendor/bundle

You should now be able to run the test suite with Rake:

$ bundle exec rake

To run the suite using Nokogiri:

$ XML=nokogiri bundle exec rake

If you plan on submitting a patch, please write tests for it (we use MiniTest::Spec).

If everything looks good, submit a pull request on GitHub and we'll bring in your changes.