Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.4 KB

README.md

File metadata and controls

34 lines (21 loc) · 1.4 KB
Raw

killbill-client-java

Java client library for Kill Bill.

Usage

The library is published in Maven Central:

<dependency>
    <groupId>org.kill-bill.billing</groupId>
    <artifactId>killbill-client-java</artifactId>
    <version>0.0.15</version>
</dependency>

The easiest way to get started is to look at some of our integration tests, which use this library.

When sending a body, if you are unsure which parameters to pass, take a look at the source code, which self-documents the required fields per call using preconditions.

Regarding error handling, if the server returns an error (400, 401, 409, 500, etc.), the code will throw KillBillClientException. If there is no response (204) or if an object cannot be found (404), the code will return null (for single objects) or an empty list (for collections of objects). Otherwise, you should never get null.

Build

To build the library:

mvn clean install

This will produce several jars:

  • killbill-client-java-x.y.z-SNAPSHOT.jar which contains only the library
  • killbill-client-java-x.y.z-SNAPSHOT-jar-with-dependencies.jar which is a self contained jar (library and dependencies)