Install

npm i @juicyllama/nestjs-recurly

Usage

1a. Add your API key to your .env if running a single-recurly account with key RECURLY_API_KEY 1b. Pass your recurly API key with each request (this takes priority) if running a single or multiple recurly accounts. 2. Integrate your NestJS application with the relevant modules (e.g. endpoints) required

You can checkout the Sandbox for an example implementation.

Types

We have typed each resource type and have exported them for your use.

You can import them into your code and reuse them.

Testing

We are using a Recurly sandbox account to run all tests locally and in our CI/CD. If you want to run the test suite, you should create an account with Recurly.

Limitations

Standard accounts don't come with features:

• account_hierarchy
• external_resource_tracking
• wallet feature

Therefore some tests have been disabled

EU Accounts

By default the package works with the default US based recurly API URL, if you are using an EU or alternative instance you should either pass the apiLocation with the request or set RECURLY_API_LOCATION in your env file e.g.

RECURLY_API_LOCATION=eu