Kaui Guide

Introduction

PDF Version of Kaui Guide

To download a PDF version of this guide, click here.

What Is Kaui?

"Kaui" (KAUI) stands for Kill (Bill) Admin User Interface. This self-contained web application interacts with Kill Bill over HTTPS.

Backoffice staff (for example, Support or Finance) will find Kaui useful to process refunds, credits, chargebacks, and so forth. Kaui also enables the Kill Bill administrator to perform more advanced tasks, such as managing tags, uploading a catalog, and configuring the tenant(s).

Other types of users who might find Kaui useful are developers (for testing), operations, and product managers.

Note: For Developers: Kaui functionality is provided via a series of Ruby on Rails mountable engines. You can extend its functionality (for example, to provide a custom UI for your plugins) by mounting your own engine(s).

How to Use This Guide

The first half of this guide explains the more basic components:

Getting Started
Basic search and Advanced search
Accounts
Payment methods
Subscriptions
Invoices
Payments
Timeline

Advanced and administrative features are covered in the second half of the guide:

Tenants
Users, roles, and permissions
Catalog
Overdue
Translation files
Tags
Custom fields

Note: The Plugin Manager and Analytics functionality is currently undocumented.

About Screenshots

The screenshots displayed in this guide may differ from what you see on your Kaui screen. That’s because your user permissions control what features you can access (i.e., what you see on the screen).

If you have any questions about why your Kaui screen doesn’t match what you see in this guide, ask your Kaui administrator.

Other Learning Resources

Videos

We regularly add new overviews and tutorials to our YouTube videos, so check in from time to time.

Glossary

The terms listed below are used frequently in this guide. We’ve provided an abbreviated description below. For a full description, see the Kill Bill Glossary.

Account (a.k.a. customer account): A record that contains details about the customer (name, address, etc.).
Child: An account that is associated with a parent account.
External Key: An alternative unique ID for an object.
Parent: An account that contains one or more child accounts.
Payment Method: A record of the details required for Kill Bill to trigger a payment.
Permissions: In Kill Bill, a defined action that can be performed in a system (for example, TAG_CAN_ADD OR ACCOUNT_CAN_CREATE). You can assign one or more permissions to a role, which can then be associated with a user. The user can only perform the permissions associated with that role.
Plan: Define how much a customer pays for a product and the frequency of the payment.
Plugin: Software that runs alongside Kill Bill in order to provide additional functionality.
Phase (a.k.a plan phase): Time periods within a subscription during which certain rules apply.
Subscription: A contract between you (the business) and a customer that associates an account with a plan and a specific start date.
Tag: A property that can be added to an object (for example, an account or a subscription) for information purposes or to affect the behavior of the system.
Tenant: The division or organization that is using Kill Bill as a group of users. Note that an organization can have more than one tenant, as Kill Bill supports multi-tenancy.
User: A person who logs on to use Kaui.
User Role: A group of permissions that specify which actions the user is allowed to perform in Kaui. A user can have multiple roles. A role can have multiple permissions.

Getting Started

First-Time Login

Note: Kill Bill handles authentication. The method your organization uses to manage users is highly configurable. For information on managing users and permissions, see the Users chapter.

To log in to Kaui:

Type in your username and password, then select the Sign In button.

Kaui displays the Add New Tenant screen:
Enter the tenant Name, API Key, and API Secret.

Note: The API key and API secret pair are used in all HTTP requests to ensure that the user issuing the request has the correct permissions to access the tenant.
Click the Save button.

Log In to Kaui

To log in to Kaui:

Type in your username and password, then select the Sign In button.
If your organization uses more than one Kill Bill tenant, select the tenant from the dropdown.
Click the Save button:

Log Out of Kaui

To log out of Kaui, select SIGN OUT in the upper right corner of the Kill Bill homepage:

Homepage Layout

The homepage is the screen that Kaui displays after you first log in.

Basic Search
Advanced Search
Plugin Manager and Analytics
Tags and Custom Fields
Users, Tenants, and Admin
Username / Tenant name and logout
Latest invoices, accounts, and payments (latest records created for this tenant)
This is Killian, the Kill Bill mascot!

Return to Homepage

From any screen in Kill Bill, you can return to the homepage by clicking the logo in the upper left corner:

Icons

Icon Description

Icon	Description
	Add—Indicates you can add an item, such as a payment method, credit, charge, etc.
	Dry-run invoice—Appears on the Account page. Clicking it manually triggers a committed or dry-run invoice.
	Expand—Expand a section or dropdown menu.
	Collapse—Collapse a section.
	Tags—_Admin-level feature:_ On the home page, click to access Tags, Tag Definitions, and Custom Fields. All users: In other locations in Kaui, click to select a tag to apply to the current object (for example, an account).
	Kaui Package Manager—Appears at the top of the screen and gives you access to plugin specific screens. (Also known as Kill Bill Plugin Manager.)
	Add-on—Appears on the Subscription screen and lets you add an add-on to the account’s subscription.
	Make a payment—Appears on the Invoice screen and lets you make a payment against the invoice.
	Users, Tenants, & Admin—_Admin level feature:_ Appears at the top of the screen and gives you access to Users, Tenants, and Admin.
	Appears in the Payment Methods section of the Account page, clicking the Refresh icon triggers a refresh for each payment plugin installed in Kill Bill, for that account. When you refresh a payment method, Kill Bill retrieves the latest payment information from where it’s stored (for example, from Stripe or another payment gateway). Note: This icon does not display if the only payment method listed is `EXTERNAL_PAYMENT`.

i PlusGreen

Add—Indicates you can add an item, such as a payment method, credit, charge, etc.

i InvoiceGen

Dry-run invoice—Appears on the Account page. Clicking it manually triggers a committed or dry-run invoice.

i DownArrow

Expand—Expand a section or dropdown menu.

i UpArrow

Collapse—Collapse a section.

i Tag

Tags—_Admin-level feature:_ On the home page, click to access Tags, Tag Definitions, and Custom Fields.

All users: In other locations in Kaui, click to select a tag to apply to the current object (for example, an account).

i Plug

Kaui Package Manager—Appears at the top of the screen and gives you access to plugin specific screens. (Also known as Kill Bill Plugin Manager.)

i Addon

Add-on—Appears on the Subscription screen and lets you add an add-on to the account’s subscription.

i CreditCard

Make a payment—Appears on the Invoice screen and lets you make a payment against the invoice.

i Gears

Users, Tenants, & Admin—_Admin level feature:_ Appears at the top of the screen and gives you access to Users, Tenants, and Admin.

i Refresh

Appears in the Payment Methods section of the Account page, clicking the Refresh icon triggers a refresh for each payment plugin installed in Kill Bill, for that account. When you refresh a payment method, Kill Bill retrieves the latest payment information from where it’s stored (for example, from Stripe or another payment gateway).

Note: This icon does not display if the only payment method listed is EXTERNAL_PAYMENT.

Grids/Tables

Grids (also referred to as tables) appear throughout Kaui to keep lists organized:

For very large grids, use the pagination controls to view different "pages:"

To sort columns on a grid, click the up/down arrow in that column’s header:

Kaui shows you which column is currently sorted by the purple arrow:

The direction of the arrow (up or down) indicates if the column is sorted in ascending or descending order.

If relevant, you can click a link in the grid to view that item’s detail. For example, on the Invoices grid, click the link to open that specific invoice:

Basic Search

Tip: To view all accounts, place your cursor in the search field and press the Enter key.

To search for customer accounts, use the basic search. Basic search is available at the top of the screen no matter where you are in Kaui.

You can search for an account using the following criteria:

Account ID
External key
Name
Email address

Basic search is also available in the center of the homepage: