Kaui is the back-office user interface for Kill Bill. This guide walks you through several tasks in Kaui. You will become familiar with moving around the application, and you’ll learn some basic Kill Bill concepts:
Before You Begin
Make sure you have installed Kill Bill and Kaui and launched them per the Getting Started guide.
Step 1. Create a Tenant
Kill Bill supports multi-tenancy, where each tenant has its own data, configuration, and so forth. This section explains how to create a tenant the first time you log in to Kaui.
Log in to Kaui with the default credentials of
Kaui prompts you to create a tenant:
Fill in the fields:
bobfor Name (tenant name).
For API Key, use
bob, and for API Secret, use
Click the Save button.
After you create a tenant, the active tenant name appears in the upper right corner of the Kaui screen:
Step 2. Set Up a Simple Catalog and Plans
The Kill Bill catalog contains products and plans definitions. This XML configuration file is really powerful and offers various options for handling trials, add-ons, upgrades / downgrades, and so forth. (For more information on the Kill Bill catalog, see the Catalog section in the Subscription Billing guide.)
For this tutorial, instead of starting with the XML catalog, you’ll learn how to create a simple catalog in Kaui and configure it with two plans.
|Note: The simple catalog supports a subset of the regular XML catalog features and isn’t intended to serve as a catalog in production. For more details on the simple catalog, see the "Simple Plan" section in the API Reference.|
To create the simple catalog and two plans:
Click the tenant name in the upper right corner:
Kaui opens the Tenant Configuration page. At the bottom of the page, you’ll see the a row of tabs:
Click the plus sign next to Existing Plans.
Kaui opens the Catalog Configuration screen.
Fill in the fields as shown below:
Click the Save button.
Kaui returns to the Tenant Configuration screen.
Click the plus sign again.
On the Catalog Configuration screen, fill in the fields as shown below:
Click the Save button, and Kaui returns to the Tenant Configuration screen.
You will now see the two plans you have created. Note that when you created the first plan, Kaui created the simple catalog:
Step 3. Create an Account
In this section, we will create an account for a customer, which stores the data your organization uses to transact business with a customer. To keep it simple, we will create an account with a minimum of information.
At the top of any Kaui screen, click Create New Account.
Kaui opens the Add New Account screen.
Fill in the Name field as shown:
Scroll down the page and click the Save button.
Kaui displays the customer name for the new account at the top left of the screen:
Step 4. Add a Payment Method to the Account
To pay its invoices, an account must have at least one payment method saved. This section explains how to add a payment method to a customer account.
For simplicity, we will create an offline payment method—checks—for the account we created in step 3.
Search for and open the customer account. (If you still have the account open from the previous section, you can skip this step.)
On the main Kaui page, click in the center text box and press the Enter key (or click the search icon).
Kaui displays the accounts you have created so far for the tenant.
Click on an account, which opens the Account page for the customer.
On the lower right, click the + sign next to Payment Methods.
Kaui opens the Add New Payment Method screen.
Verify that ___EXTERNAL_PAYMENT___ appears in the Plugin name field and check the Default payment method checkbox.