General Information

Who is behind Kill Bill?

Kill Bill is an open-source project which started at Ning in 2010 by Martin Westhead, Pierre-Alexandre Meyer and Stéphane Brossier.

You can follow our blog, to get insights on what the team is working on.

Where is the code?

All of our code is hosted on Github, in the killbill organization. The core of the Kill Bill platform can be found here.

How is Kill Bill different?

Contrary to any SaaS solution:

  • Kill Bill is open-source

  • Kill Bill has a pluggable architecture, allowing you to write plugins (i.e. custom code) to extend or change default behaviors

  • Kill Bill is not a batch system by default, but instead uses an event oriented architecture. Modules share and react to events: for example, the invoice module sends an invoice creation event on the message bus whenever a new invoice is generated, to which the payment module reacts and triggers the actual payment. These events are available to plugins, so you can write custom logic the same way.

How mature is the project?

Kill Bill is currently running in production in various companies and has been invoicing millions of dollars and charging hundreds of thousands of credit cards over the past few years. We perform thousands of tests before each release, and introduce regression tests whenever bugs are discovered.

Note though that Kill Bill is a platform to build billing systems. There are infinite combinations of configurations possible and we cannot test them all. We provide a test framework to help you verify your system before going to production. Take also extra care when installing third-party plugins (only the plugins hosted on our GitHub organization are officially supported).

How stable are your APIs?

We try to maintain backward compatibility as much as we can, but Kill Bill being an active project, new APIs are frequently introduced to support new features. We provide official clients (Ruby, PHP, Java, etc.), so generally, you don’t have to worry about it. If you are a plugin maintainer and have questions regarding the API version you should be using, drop us a note on our mailing-list.

What kind of tests do you perform?

There are thousands of tests that we perform before each release:

  • Unit tests

  • Functional tests

  • Java library integration tests

  • Server integration tests, to check the REST APIs

  • Client APIs integration tests

We are not a Java shop. Can we still use Kill Bill?

Yes! We try to hide most of the complexity so you can use simply Kill Bill as a service, using our client libraries. Currently, plugins can only be written in Java or Ruby though. Check out our userguide for tutorials on how to deploy Kill Bill.

Where to start?

Try our Getting Started tutorial.

Features

Is it only for recurring billing? Is usage billing supported?

The core of the platform is agnostic to the type of billing you use: Kill Bill supports recurring billing, usage billing and one-time transactions. Kill Bill is designed to be modular and most features can be turned on or off as you need. Note that usage billing is a fairly large topic and we invite you to check out this blog post to understand the various types of usage.

How do I insert my custom billing logic?

There are various ways of customizing Kill Bill. Besides System Properties, which let you configure the core platform, most internal modules have a second, more advanced, layer of configuration, usually through XML files. These let you configure the dunning (overdue) policy, the various plans and billing policies, etc.

If you need more advanced (billing or non-billing) logic, Kill Bill has a plugin capability. You can write custom code (in Java or Ruby) to extend or even override Kill Bill default behaviors.

Finally, Kill Bill is open-source! We are happy to accept contributions.

My customers are global, what is your internationalization support?

The core of the billing platform was designed to be internationalized. The catalog module has support for all currencies, including crypto-currencies (e.g. Bitcoin). The invoice module will understand these various currencies and respect localization rules. For example, it will correctly round US dollars to two decimal places but Japanese Yen amounts will have no decimal portion.

Accounts can have a designated locale (for example, $1,234.99 will be displayed as 1.234,99 $ for accounts with the French Canada locale) and timezone (to generate invoices in their timezone, instead of the merchant’s).

From a payment perspective, Kill Bill supports payment gateways via plugins. If your international gateway isn’t supported yet, you can simply write a plugin for it. All of Active Merchant processors can be handled.

What is a (subscription) bundle?

A bundle is a collection of subscriptions. A typical bundle has exactly one BASE subscription and a collection of ADD_ONs. Grouping logically these subscriptions together makes it easier to automatically cancel all ADD_ONs when the BASE subscription is cancelled for example.

Can I create subscriptions without billing information?

Yes! If you are not ready to charge your customers (for example, during an activation phase), you can configure your plan with an initial free phase. Alternatively, you can set the AUTO_PAY_OFF tag to their account and Kill Bill will generate invoices but won’t attempt to charge them. When you decide to remove this tag, payments will automatically occur.

Can I create an account without a subscription?

Absolutely! This can be useful during onboarding flows, if you need your customer in your CRM engine, databases, etc. but before she has actually signed-up.

What are the types of payment methods supported?

Kill Bill supports all credit and debit cards your payment gateway supports. Additionally, tracking of external payments (ACH, checks, cash, …) is also a feature: when you receive the money, simply let Kill Bill know about it (either via our administrative UI or our APIs).

Are you PCI compliant?

Even if Kill Bill is used in PCI compliant companies today, it is your responsibility to get certified. Depending on how you plan to use Kill Bill, you can outsource most of the PCI complexity to your payment gateway by not storing credit card information. Check the PCI DSS website for more information.

How can I secure my Kill Bill installation?

Here are some general tips on securing your Kill Bill installation:

  • Install Kill Bill behind a firewall (it should not be exposed on the public internet)

  • Change the default username/password (admin/password) in your live environment

  • Don’t store sensitive data in Kill Bill. While most plugins have support for directly saving card or bank account numbers for instance, this should only be used for testing purposes or if you use a proxy tokenizer: if you don’t, use a third-party vault

  • Encrypt username and passwords in configuration files (for yml files, we recommend the symmetric-encryption gem)

  • Use SSL for all communication with your eCommerce application as well as with the payment providers

  • Subscribe to our mailing-list to receive security advisories

  • Never store security codes (CCV, CVV, etc.) in your live environment

It is eventually your responsibility to make sure your Kill Bill installation is secure and compliant.

Do you support Tax?

Because Tax varies from countries to countries, support is available via invoice plugins integrating with specific Tax providers.

Kill Bill can be integrated with Avalara AvaTax, as a tax provider. The plugin can be downloaded here.

Large catalog

If you have a very large catalog (e.g. thousands of products) and/or if it is highly dynamic, maintaining the catalog as an XML file may not be practical. Instead, you can use the CatalogPluginApi to write a plugin that would provide an alternative catalog implementation (such as integrating with your existing catalog system).

Here are Java and Ruby examples.

Coupons and discounts

There are several ways to handle coupons and discounts:

  • The simplest option is for your catalog to include discount plans (plans can additionally include discount phases)

  • An alternative is to use the PhasePriceOverride element when creating a subscription

  • Finally, to implement a fully fledged coupon functionality, use the EntitlementPluginApi to write your custom plugin (here is an example)

For more details, check this blog post.

Email notifications

The email notifications plugin lets you send emails to your customers regarding upcoming invoices, payment successes and failures, subscription cancellations, etc.

Testing subscription changes over time

We have a clock abstraction in Kill Bill that can be manipulated through an API, as long as you start Kill Bill with org.killbill.server.test.mode=true:

curl -v \
     -u admin:password \
     -H "X-Killbill-ApiKey: bob" \
     -H 'X-Killbill-ApiSecret: lazar' \
     -H "Content-Type: application/json" \
     -H 'X-Killbill-CreatedBy: admin' \
     "http://127.0.0.1:8080/1.0/kb/test/clock"

curl -v \
     -u admin:password \
     -H "X-Killbill-ApiKey: bob" \
     -H 'X-Killbill-ApiSecret: lazar' \
     -H "Content-Type: application/json" \
     -H 'X-Killbill-CreatedBy: admin' \
     -X POST \
     "http://127.0.0.1:8080/1.0/kb/test/clock?requestedDate=2015-12-14T23:02:15.000Z"

curl -v \
     -u admin:password \
     -H "X-Killbill-ApiKey: bob" \
     -H 'X-Killbill-ApiSecret: lazar' \
     -H "Content-Type: application/json" \
     -H 'X-Killbill-CreatedBy: admin' \
     -X PUT \
     "http://127.0.0.1:8080/1.0/kb/test/clock?days=10"

Here is an example how it could be used in tests.

Development

Does Kill Bill run in the cloud?

Kill Bill has successfully been deployed in private datacenters as well as in AWS, Heroku, OpenShift, Azure, etc. We also provide scripts to ease the deployment story. Check out the killbill-cloud repo on Github.

What are the environment requirements?

This is a tough one to answer as it depends on the plugins you want to be running, your expected traffic, etc. If in doubt, send us your details on the mailing-list.

How can I listen to Kill Bill events?

You can either write a custom plugin and register it on the external bus or register an endpoint that Kill Bill will send events to via HTTP POST (check the /1.0/kb/tenants/registerNotificationCallback resource).

How to contribute?

Find the project you want to contribute to on GitHub and follow the Fork & Pull Collaborative Development Model. If you are not sure where to start, drop us a note on the mailing-list.

Licensing

All contributed code must be license under the Apache License, Version 2.0.

Building from source

Kill Bill is a standard Maven project. Simply run the following command from the project root directory:

mvn clean install -DskipTests

On the first build, Maven will download all the dependencies from the internet and cache them in the local repository (~/.m2/repository), which can take a considerable amount of time. Subsequent builds will be faster.

Once built, you can start Kill Bill by running:

./bin/start-server -s

Note that master is in development, so some dependencies may have to be built from source as well (such as killbill-oss-parent, killbill-commons and killbill-platform).

Calling APIs from Ruby plugins

Take a look at these snippets.

Reloading plugins

When developing plugins, you can update the plugin Jar or the plugin Ruby code directly, then tell Kill Bill to reload it:

curl -v \
     -u admin:password \
     -H "X-Killbill-ApiKey: bob" \
     -H 'X-Killbill-ApiSecret: lazar' \
     -H "Content-Type: application/json" \
     -H 'X-Killbill-CreatedBy: admin' \
     -X POST \
     -d '{"systemCommandType":"true","nodeCommandType":"RESTART_PLUGIN","nodeCommandProperties":[{"key":"pluginName", "value":"analytics-plugin"} ]}' \
     "http://127.0.0.1:8080/1.0/kb/nodesInfo"

Troubleshooting

When asking for help on the mailing-list, provide us your catalog XML, server side logs and curl commands to reproduce the problem. Additional information, such as your JVM, container and OS versions, are very helpful too.