Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.withorb.com/llms.txt

Use this file to discover all available pages before exploring further.

A key benefit of Orb is the ability to understand the utilization of your customers as it happens, rather than with a manual or batch process. Visibility into accrued usage can help you identify trends among your customers, assess account health, and provide insights into business opportunities.

​
Usage visualizations

A subscription detail page presents usage in multiple formats:
  • Orb’s real time usage graphs show quantities split by day for each billable metric connected to the subscription. This view always displays fresh results on the basis of all events that have been ingested by the system. If your subscription’s plan charges for compute and storage costs, you will be presented a separate daily graph for both metrics. These graphs also allow you to view historical usage up to 90 days in the past, and compare trends with the previous billing cycle.
  • The invoice preview shows the upcoming invoice resource for this billing period, with details on fixed fees, usage quantities, and the total amount for each line item. When working with a prepaid plan, the invoice preview will also show deductions to the balance over the current billing period.
  • Historical invoices show finalized invoice PDFs. Invoice PDFs contain a breakdown of all line items along with billing metadata, tax information. Note that once an invoice PDF is finalized, its amounts are frozen. For auditing reasons, Orb will not dynamically regenerate a finalized invoice.
view_subscription_usage.png

​
Programatically receiving usage

Orb’s view subscription usage endpoint enables you to retrieve usage over time in a structured format. This API is quite flexible, allowing you to optionally group usage for a metric by an event property (e.g. to view compute per region), query over custom time ranges, and to window usage. Retrieving usage can be especially useful to power in-product visibility for your end customers. Giving your customers the ability to understand their utilization in real time can significantly reduce your customer support volume due to surprising invoices with high utilization amounts or overages.

​
Usage-based triggers

In order to automatically action based on usage trends, Orb provides webhooks and natively supported workflows such as automatic top-ups for prepaid plans.