Java library for Recurly, originally developed for Kill Bill, an open-source subscription management and billing system.
The library is distributed via Maven Central:
<dependency>
<groupId>com.ning.billing</groupId>
<artifactId>recurly-java-library</artifactId>
<version>0.113.18</version>
</dependency>
The easiest way to get started is by looking at the code examples in TestRecurlyClient.java.
- Make sure you can build the project by running the smoke tests:
mvn clean test
- Go to recurly.com and create an account. This account will be used as a sandbox environment for testing.
- In your Recurly account, click on API Credentials (bottom of the left menu), click the Enable API Access button and write down your API Key.
- Verify the setup by running the recurly-java-library integration tests (make sure to update your API Key and Subdomain):
mvn clean test -Pintegration -Dkillbill.payment.recurly.apiKey=1234567689abcdef -Dkillbill.payment.recurly.subDomain=mycompany
- Go to your Recurly account, you should see some data (e.g. account created).
- Congrats! You're all set!
- Set
-Drecurly.debug=true
to output debug information in the info log file - Set
-Drecurly.page.size=20
to configure the page size for Recurly API calls - To run the tests, one can use
-Dkillbill.payment.recurly.currency=EUR
to override the default USD currency used - You may optionally pass the TLS protocol used with the setting
-Dkillbill.payment.recurly.tlsProtocol
. Keep in mind that Recurly only supportsTLSv1.2
and above. This setting defaults toTLSv1.2
.
See https://gist.github.com/dbathily/4433939 for an example on how to set it up.
To build the project, use maven:
mvn clean install