All guides▾
Catalog & pricing

Billing Units

How to set up and manage Billing Units — the named units your usage-based pricing is measured against.

What this does for you

Billing Units are the named units your usage-based pricing measures against — "API call," "seat," "GB of storage," or anything else your product bills customers by volume of. You build a small catalog of these once, then reference them from your usage-based Plans, Products, and Usage Compilations, so your pricing, metering, and every customer's prepaid wallet all speak the same vocabulary.

Each billing unit gets a BUID — a short reference id other parts of the product (wallets, usage tracking, imports) use to identify it.

Who can use it

Billing Units is a self-service feature your admin can turn on or off for your organization; when it's on, access within it is controlled by role permissions:

  • Viewing the Billing units page requires billingUnit.view.
  • Creating a billing unit requires billingUnit.create.
  • Editing requires billingUnit.edit.
  • Archiving or reactivating requires billingUnit.archive.

If you don't have the right permission, the page shows "You don't have access to this page — Please contact your admin to help you with that," and action buttons are disabled with a tooltip asking you to contact your admin.

Where to find it

Go to Settings → Configure billing → Billing units (/settings/configurebilling/billingunits).

The list page shows every billing unit in your organization — BUID, Billing unit name, Status, Created on, and Last active on — with search ("Search billing units"), filtering, sorting, and column customization available from the table toolbar.

How to use it

Creating a billing unit

  1. Click + New billing unit. A panel titled New billing unit opens on the right.
  2. Fill in the Billing unit name and Status.
  3. Choose how its BUID is assigned: Generate automatically (the default — Kribana assigns the next id for you) or Type manually (enter your own id, required if you pick this option).
  4. Click Create.

If you close the panel with unsaved changes, you'll be asked to confirm ("Discard unsaved changes?") before they're dropped.

Editing a billing unit

Use the row's Edit action. This reopens the same panel, titled Edit billing unit, pre-filled with its current values — its BUID is shown locked with a "SYSTEM" badge here, since it can't be changed once the billing unit is created. Update the name or status and click Update.

Archiving and reactivating a billing unit

Use the row's Archive / Unarchive action. You'll be asked to confirm — "Do you want to archive/activate this billing unit — [name]?" — before the status change goes through. There's no delete action; archiving is how you retire a billing unit you no longer use.

Exporting billing unit data

Use the Export button at the top of the list — Current table data (the columns currently visible) or Full data export (every field).

Bulk-loading billing units

Billing Units are one of the collections available from Settings → Imports — pick Billing Units when starting a new import to load a batch from a CSV or JSON file instead of creating them one at a time.

Tips / things to know

  • A BUID can't be changed after you create the billing unit — decide upfront whether you want Kribana to generate one or want to type your own.
  • Two billing units can end up with the same display name today — the interface doesn't block it, so if that happens, tell them apart by their BUID.
  • There's no delete action in the interface — archiving is how you retire a billing unit you no longer use.
  • Whether a BUID or billing unit name must be unique (and at what scope — your organization vs. the whole platform) is enforced on the backend rather than shown to you upfront in the create form; if a save fails, check the error message for a duplicate-id conflict.