Documentation

BillingDB Documentation v1.0.0

BillingDB Documentation v1.0.0

Concepts

Account

Basic entity that represents an account. It is the root of the hierarchy.

Admin

An account that has the ability to manage all accounts.

Customer

BillingDB’s customer’s account.

Customer’s Customer

BillingDB’s customer’s customer’s account.

Product

Represents a product that is sold to a customer.

Operation

Represents an operation that is performed on a product that is subject to charging. It has a name and unit of measure e.g. transaction or GB

Charge

Charge is a definition how to bill an operation relative to its unit of measure. It finally lands on the invoice as a charge item.

Plan

Plan is a collection of operations that are performed on a product with defined charges. It has a name and typically progresses gradually with more operations and higher effective monthly cost.

Contract

Contract represents an association between account and plan. Typical case is subscription.

Usage

Usage is data that is collected from the customer’s system and is used to calculate charges. Based on operations reported, respective charges apply. The data is aggregated prior.

Ingestion

The process of reporting usage data to BillingDB so it is captured and can be used for charging.

Aggregation

The process of “rolling up” data e.g. multiple events from 1 minute get aggregated into 1 event with operation metrics summed up. The aggregation is done per account and operation in the time dimension.

Invoice

API

Also see.