Skip to main content

Billing platform · Docs

Billing that comes back right.

Everything you need to model catalogs, capture orders, rate usage, and send invoices with Billerang, the multi-tenant monetization platform. Learn the product, then build on the v1 API.

Start in 5 minutes Explore the API v1

first-invoice.sh

# 1. authenticate
TOKEN=$(curl -s $KC_URL \
  -d grant_type=client_credentials | jq -r .access_token)

# 2. create an order
curl -X POST $API/api/v1/orders \
  -H "Authorization: Bearer $TOKEN" \
  -d @order.json

# 3. run billing
curl -X POST $API/api/v1/runs -d '{"type":"BILLING"}'

invoice INV-00001 returned

For product & ops teams

Use Billerang

A functional guide that mirrors the product: accounts, catalog, orders, usage, billing, and receivables.

Open the platform guide

For developers & integrators

Build on Billerang

The canonical v1 REST API: auth, principles, quickstarts, and interactive explorers, all TDD-backed.

Open the developer guide

Explore by module

The docs follow the same structure as the app. Pick a module to go deep.

Accounts

Sellers, customers, and the business account hierarchy.

Catalog

Offers, products, charges, and price plans.

Orders & Subscriptions

Capture orders and drive the subscription lifecycle.

Usage & Rating

Ingest usage, rate events, and manage wallets.

Billing

Bill runs, aggregation, invoicing, and eInvoicing.

Receivables & Payments

Account operations, matching, and reconciliation.

Operations

Runs, automations, and the batch job engine.

Workbench

Query Studio and governed data exploration.

Your first API call

Three steps to a live invoice

Authenticate with Keycloak, send one order, run billing. Every v1 endpoint follows the same conventions.

Get a bearer token
A client_credentials grant from Keycloak returns a short-lived token.
Call an endpoint
Send your request to /api/v1/... with the token in the Authorization header.
Read the response
Every entity comes back with an auditable block and consistent error semantics.

API v1 ExplorerLiveInteractive reference for all 500+ operations.Postman collection534 reqs534 ready-to-run requests with auto-auth.Connect Portal APITenant onboarding and SSO endpoints.AuthenticationOAuth2 / Keycloak setup, step by step.

See it in the real world

End-to-end billing patterns modeled on real products.

Streaming subscriptions

Tiered plans, upgrades, and proration at scale.

AI usage billing

Meter tokens, rate per model, invoice monthly.

Meal vouchers

Prepaid balances, reservations, and settlement.

SUBSCRIPTIONUSAGE

Media & publishing

Bundles, entitlements, and recurring access.

Cloud infrastructure

Metered resources with committed-use discounts.

Ready to send your first invoice?

Follow the quick start and go from catalog to invoice in one sitting.

Start the quick start