Recurly API Wrapper

A simple and light-weight interface wrapper for Recurly.

Installation

$ npm install easyrecurly

Benefits

- Very easy to send objects in JSON, xml is generated for you.
- Complete coverage of the API.
- Result paging support.

Configurations

Create a config file similar to this:

	module.exports = {
		apiKey: 'Recurly Private API Key',
		subdomain: 'https://example.recurly.com'
	};

Usage

	var Recurly = require('easyrecurly');
	var eRecurly = new Recurly(require('./config'));

API Calls

Accounts (Doc Ref)

eRecurly.accounts.list([filter], callback)

eRecurly.accounts.create(details, callback)

eRecurly.accounts.update(accountCode, details, callback)

eRecurly.accounts.get(accountCode, callback)

eRecurly.accounts.close(accountCode, callback)

eRecurly.accounts.reopen(accountCode, callback)

eRecurly.accounts.notes(accountCode, callback)

Billing Information (Doc Ref)

eRecurly.billingInfo.update(accountCode, details, callback) 

eRecurly.billingInfo.get(accountCode, callback) 

eRecurly.billingInfo.remove(accountCode, callback) 

Adjustments (Doc Ref)

eRecurly.adjustments.get(accountCode, callback)

eRecurly.adjustments.create(accountCode, details, callback)

eRecurly.adjustments.remove(uuid, callback)

Coupons (Doc Ref)

eRecurly.coupons.list([filter], callback)

eRecurly.coupons.get(couponCode, callback)

eRecurly.coupons.create(details, callback)

eRecurly.coupons.deactivate(couponCode, callback)

Coupon Redemtion (Doc Ref)

eRecurly.couponRedemption.redeem(couponCode, details, callback)

eRecurly.couponRedemption.get(accountCode, callback)

eRecurly.couponRedemption.remove(accountCode, callback)

eRecurly.couponRedemption.getByInvoice(invoiceNumber, callback)

Invoices (Doc Ref)

eRecurly.invoices.list([filter], callback)

eRecurly.invoices.listByAccount(accountCode, [filter], callback)

eRecurly.invoices.get(invoiceNumber, callback)

eRecurly.invoices.create(accountCode, details, callback)

eRecurly.invoices.markSuccessful(invoiceNumber, callback)

eRecurly.invoices.markFailed(invoiceNumber, callback)

Subscriptions (Doc Ref)

eRecurly.subscriptions.list([filter], callback)

eRecurly.subscriptions.listByAccount(accountCode, [params], callback)

eRecurly.subscriptions.get(uuid, callback)

eRecurly.subscriptions.create(details, callback)

eRecurly.subscriptions.update(uuid, details, callback)

eRecurly.subscriptions.cancel(uuid, callback)

eRecurly.subscriptions.reactivate(uuid, callback)

eRecurly.subscriptions.terminate(uuid, refundType, callback)

eRecurly.subscriptions.postpone(uuid, nextRenewalDate, callback)

eRecurly.subscriptions.preview(details, callback)

eRecurly.subscriptions.previewChange(uuid, details, callback)

Plans (Doc Ref)

eRecurly.plans.list([filter], callback)

eRecurly.plans.get(planCode, callback) 

eRecurly.plans.create(details, callback)

eRecurly.plans.update(planCode, details, callback)

eRecurly.plans.remove(planCode, callback)

Plan Add-ons (Doc Ref)

eRecurly.planAddons.list(planCode, [filter], callback)

eRecurly.planAddons.get(planCode, addonCode, callback) 

eRecurly.planAddons.create(planCode, details, callback)

eRecurly.planAddons.update(planCode, addonCode, details, callback)

eRecurly.planAddons.remove(planCode, addonCode, callback)

Transactions (Doc Ref)

eRecurly.transactions.list(filter, callback) 

eRecurly.transactions.listByAccount(accountCode, [filter], callback)

eRecurly.transactions.get(id, callback)

eRecurly.transactions.create(details, callback) 

eRecurly.transactions.refund(id, amount, callback)

Configuration

• apiKey (String) - Private api key for your recurly account.
• subdomain (String) - Recurly subdomain with companyname. (No trailing slash)
• debug (Boolean) (Default: false) - Debug output.

History

• v0.0.6 (2014-12-28) -- (a bit long for this section, read History.md)
• v0.0.5 (2014-12-28) -- Dependencies updated.
• v0.0.4 (2014-12-23) -- XML builder replaced by JS2XML.
• v0.0.3 (2014-11-28) -- Dependencies updated.
• v0.0.2 (2014-10-14) -- Dependencies updated.
• v0.0.1 (2014-08-27) -- Initial release.

License

The MIT License (MIT)

Copyright (c) 2014-2015 Talha Asad

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.