Skip to main content
Build your first usage-based pricing model in Orb. This quickstart walks through event ingestion, metric definition, your product catalog and pricebook, plan creation, and invoice generation—showing how Orb’s query-based architecture supports flexible, auditable billing.

What you’ll build

A complete usage-based billing workflow:
  • Ingest raw usage events (API calls, compute hours, or any measurable activity from your product)
  • Define a billable metric as a query over your events
  • Build a product catalog with shared prices (per-unit, tiered, or volume-based)
  • Package catalog prices into a plan
  • Create a customer subscription linking them to your pricing
  • Generate an invoice calculated from actual usage

Prerequisites

Before starting, ensure you have:
  • Orb account — Test mode recommended for this quickstart. Sign up with your work email or Google account if you don’t have one.
  • API key — Create one in test mode from Developers → API keys. Required for API requests.
  • Your usage data schema — Understand what events you’ll send and what properties they’ll include.
  • 30 minutes — Estimated time to complete all steps.

The implementation path

This quickstart follows the natural data flow in Orb’s query-based architecture:

1. Ingest events

Send raw usage data to Orb. Events are stored immutably as the foundation for all billing calculations.

2. Create metrics

Define billable metrics as queries over your events. See how metrics can be changed without re-ingesting data.

3. Build your product catalog

Define what you’re selling. Create products and attach prices to them—the pricebook that everything downstream references.

4. Package prices into a plan

Reference catalog prices in a plan that describes how you bill your customers, keeping your catalog the single source of truth.

5. Create subscriptions

Link a customer to your pricing. Orb begins tracking usage and calculating charges in real-time.

6. Set up invoicing

Generate your first invoice from actual usage. Understand how invoices are deterministic queries, not side effects.

7. (Optional) Explore simulations

Run “what-if” scenarios to test pricing changes against historical usage before deploying them.

What you’ll learn

  • Why sending raw events once lets you change billing metrics anytime without re-instrumentation
  • How to test pricing changes against real usage data before deploying them to customers
  • Why late-arriving data and backfills work without manual reconciliation or invoice corrections
  • How to trace every invoice charge back to its source events for complete audit trails
  • The foundation for Revenue Design workflows that eliminate cross-functional coordination

Success criteria

By the end of this quickstart, you’ll have:
  • Events flowing into Orb via API
  • A billable metric calculating in real-time
  • A centralized product and price catalog
  • A plan referencing your catalog prices
  • A customer subscription tracking usage
  • An invoice generated from actual usage data

Ready to start?

Begin with event ingestion: Ingest events →
Use test mode for this quickstart. Test mode is completely isolated from production and safe for experimentation. You can always promote configurations to live mode later.