Recurly

API Basics

Recurly exposes a rich REST API. This article describes the basics of authenticating and interpreting results from the API.

API v2 Endpoint

API requests to Recurly should be routed through your subdomain:

https://:subdomain.recurly.com/v2/

Timeouts

Most API requests to Recurly should be rather quick. Please anticipate slower requests when performing any API request that performs a transaction. If you are using a PayPal sandbox gateway, please set your timeout to 60 seconds. For all other gateways, 30 seconds is usually more than sufficient for even the slowest transactions. Most transactions complete within 2-4 seconds.

Embedded URIs

Most associated resources are embedded at the top of a resource’s XML representation as a contentless node with an href attribute pointing to the association in question.

Actions are similarly embedded at the bottom in anchor tags, with a name attribute describing the action, and a method attribute describing the HTTP method required at the location.

If the associated object does not exist, or the action is unavailable, it will not appear in the XML. An account without an active coupon redemption, for example, will not include a redemption node, nor will an expired or maxed-out coupon include a redeem action node.