Monetizing AI products? See AI monetization for guidance on usage-based billing, prepaid credits, wallets, and hybrid pricing patterns for AI products.
| Building block | What it does |
|---|---|
| Usage events | Raw customer activity sent to Hyperline through a CSV import, API, data loader, or test simulation. |
| Aggregator | Turns usage events into one billable metric, such as a count of API calls or the sum of stored gigabytes. |
| Usage product | Defines what you sell and how that metric is priced. |
| Subscription | Assigns the product to a customer, with billing, payment, and metering settings. |
Before you start
Make sure you have:- A customer to test with, or permission to create one in Customers
- A usage metric you want to bill, such as API calls, processed transactions, or storage volume
- Usage data available through one of the supported ingestion methods
- A test mode workspace if you want to experiment before billing real customers
Example 💡
You sell an API product with a monthly platform fee and a usage-based add-on. The add-on bills each customer for the number of API calls they make during the month. To set this up, you send API call events to Hyperline, create an aggregator that counts those events, link the aggregator to a usage product, then add that product to the customer’s subscription.
Setup flow
1. Connect usage data
Hyperline needs usage events before it can calculate a usage-based charge. Choose the ingestion method that matches where your usage data already lives:CSV import
Upload usage events from a spreadsheet or exported report.
API
Send events from your application or backend systems.
Data loaders
Pull usage data from a connected database or warehouse.
Simulated events
Create test usage directly from a customer page in test mode.
If you are still exploring the model, use simulated events in test mode. You can validate the subscription and invoice behavior before connecting a production data source.
2. Create an aggregator
Go to Usage > Aggregators, then click New aggregator. An aggregator defines how Hyperline turns raw events into a billable number. Configure:- Event type: the event category to measure, such as
api_call,transaction, orstorage_snapshot - Operation: how the metric is calculated
- Unit name: the label shown in usage charts, prices, invoices, and the customer portal
- Filters: optional rules that include only matching events
| Operation | Use it when |
|---|---|
| Count | Each matching event should count as one unit, such as one API call or one transaction. |
| Sum | A numeric field on the event should be added up, such as gigabytes stored or compute minutes. |
| SQL formula | You need a custom calculation, such as applying an allowance, cap, or adjustment before billing. |
3. Create a usage product
Go to Products, click New product, then choose Usage. When configuring the product:- Add the product name and description.
- Select the aggregator you created.
- Configure at least one recurring price.
- Choose the pricing model and tiers that match your commercial offer.
- Save the product.
Usage products are configured in the product catalog, then reused in quotes, subscriptions, and customer-specific agreements. See Products and prices for the full product setup reference.
4. Add the product to a subscription
Once the usage product has a recurring price, assign it to a customer subscription.- Open the customer page.
- Click Actions > Assign new subscription, or go to Subscriptions and click New subscription.
- Select the customer and subscription start date.
- Click Add product and select the usage product.
- Review the product price, billing interval, and metering settings.
- Open Payment settings.
- For testing, choose Manually later so the subscription can be created without collecting payment immediately.
- Click Assign subscription.
5. Check usage and invoices
After events are connected and the subscription is active, validate the setup from the customer page:- Open the customer’s Usage tab to see current aggregator consumption.
- Open the customer’s Subscriptions tab to review usage on the active subscription.
- Click Explore or the usage detail icon to inspect the events behind the total.
- Open the customer’s Invoices tab to check the
openinvoice preview for the current period.
open invoice is a live preview. For usage-based subscriptions, it updates as new events are recorded. At the end of the billing period, the invoice enters the configured grace period before it is finalized and sent for payment.
Common first checks
If the subscription does not show the usage you expect, check these items first:- The event timestamps fall inside the subscription’s current metering period.
- The event type matches the aggregator’s Event type.
- The event belongs to the same customer as the subscription.
- The aggregator filters do not exclude the events.
- The usage product is included in an active subscription.
Next steps
Follow the full setup guide
Walk through an end-to-end usage-based subscription setup.
Configure aggregators
Learn how count, sum, formulas, filters, and thresholds work.
Explore customer usage
Monitor consumption and inspect the events behind each metric.
Review metering settings
Understand subscription-level metering periods and usage windows.
Is something still unclear? Don’t hesitate to reach out to our team via the in-app chat if you need additional support.

