Skip to content

Getting started

Getting started

Cbox Billing is a consolidated engine of billing modules, each fronted by a contract you bind in its service provider and each shipping an in-memory default plus a durable adapter. Start here to install it and to get the mental model before diving into individual modules.

In this section

Page What
Installation Composer install, config publish, migrations, and durable-store selection.
Architecture & foundation contracts The three-layer model (enforcement / metering / money), the data model, ledger invariants, and the cbox-id seam.

The module map

Module Concept page Responsibility
Metering Metering & enforcement Real-time hard limits, multi-dimensional buckets, the immutable event log.
Wallet Wallets & credits Credit pools, the behaviour matrix, lot expiry, forfeiture.
Ledger Ledger Double-entry, append-only, derived balances, two-phase transfers.
Reconciliation Reconciliation Convergent delta-vs-checkpoint truing-up.
Subscription Subscriptions & proration Lifecycle, preview-equals-charge proration, forfeiture transitions.
Entitlement Entitlements Coarse tier projection, outage audit, bulk rollout.
Account Accounts Currency lock, account standing.
Catalog / Pricing / Seller Catalog & pricing Versioned products/prices, coupons, seller-of-record routing.
Quote / Invoice Quotes & invoicing Tax-composed quotes, per-seller invoice numbering, credit notes.
Payment Payments & dunning Gateway-agnostic charging, dunning, the webhook ingest seam.
Refund Refunds & chargebacks First-class refunds and chargebacks as ledger reversals.