Skip to main content

Overview

tip

Get started with a 30 day free trial of Orb. Not ready yet? Check out Orb's demo environment with sample data for multiple use cases.

Architecture principles​

Orb's architecture is built with the following principles in mind:

  1. Accurate and auditable: Orb gives you the visibility to trace how each event contributes to your billing process. The platform is designed to be resilient to failure scenarios through the use of audit-safe amendments.
  2. Built for real time scale: Orb's event-based APIs, such as event ingestion, are designed to handle extremely high throughput and scale with concurrent load. Orb also provides a real-time event balance and a highly performant webhooks architecture.
  3. Flexibility at the forefront: Orb places a core focus on the extensibility of the platform, providing a custom SQL metrics layer and a custom pricing platform.

orb_overview.png

Integrating with Orb​

Orb is designed to be quick to integrate, with an available sandbox to test the platform's functionality. The overall structure of the integration involves:

  • Ingesting events and building your metrics. With these pieces in place, Orb can consume an event stream and automatically keep usage quantities up to date.
  • Setting up your plans and pricing in a product catalog. This step associates your metrics with your business motion and pricing model.
  • Provisioning subscriptions for each of your customers, so you can track usage in real time. Tracking the subscription lifecycle and accrued usage through Orb gives you a better window into account health and creates new opportunities for revenue growth.
  • Configuring invoicing and payment, which allows Orb to automatically process charges and issue invoices on your behalf. This eliminates manual data entry and streamlines communication with your customers.

Working with the API​

Orb's API is designed around REST principles, where core billing models are the resource entities. To best understand how different entities interact with each other, it's helpful to understand the core data model concepts.