Skip to main content
Hyperline offers a way to represent credits for each of your customers and provides a dedicated credit product type for this. It can represent any granted quota relevant to your business. This allows you to easily implement a pre-built ledger, enabling your customers to pay upfront, consume, and purchase new credits as needed.
PrerequisiteTo configure credits, you will need to have connected events first so usage data can be detected.

​
Create a credit product

To get started with credits, you should create a credit product first in your catalog, where you will specify the events that rule the consumption. Usage of credits will be deducted automatically accordingly.
1

Select create new, product and choose the credit product

2

Product configuration

You can set a limit to warn of a low balance and set-up which event will consume credits on the customer’s balance.
3

Pricing configuration

For credits, the pricing type is bundle pricing, a given price for a number of credits. You can also choose to display different purchase options on the customer’s portal.

​
Set up credits on a customer

Once your credit product is set up, you can enable a credit balance on your customer and link their credit usage immediately. Note that this can also be done via the API.
1

On the customer's details page, go to the “Credits” tab and click on “Add credit balance”

2

Credit balance form

Here, you can also change the name, choose the starting balance, and set the credit warning limit. This won’t override the values previously set in your product catalog, but will be specific to the customer.
3
Once the balance is created, you will be able to see the most recent consumption by your customer. Additionally, you can manually top up or retain usage via the interface if desired.

​
Add credit products in plan and subscription

Credit products created in the product catalog can be added to predefined billing plans and subscriptions like any other product. Options for this product can also be changed at the customer/subscription level, allowing full customization without altering your catalog configuration.

​
Credit expiration

Credits can be configured to expire automatically, ensuring that unused credits don’t remain on customer balances indefinitely. There are two ways to set up credit expiration:

​
Expiration after a fixed number of days

Set a specific number of days after which credits will expire. This is useful for promotional credits or time-limited offers. When configuring a credit product on a subscription, you can specify how many days after the topup the credits will expire.

​
Expiration at the end of the billing period

Credits can be configured to expire at the end of each billing period. This is useful for monthly or annual credit allowances that should not roll over. When configuring a credit product on a subscription, you can enable this option. Credits will automatically expire when the billing period ends, and new credits will be added at the start of the next period.
When credits expire, an expiration transaction is automatically created in the credit ledger, and the customer’s balance is reduced accordingly. The oldest credits expire first.

​
Auto-topup

Auto-topup allows you to automatically replenish a customer’s credit balance when it falls below a specified threshold. This ensures uninterrupted service for your customers and reduces manual intervention.

​
How auto-topup works

When a customer’s credit balance drops below the configured low balance threshold, Hyperline can automatically:
  1. Create an invoice for the topup amount
  2. Charge the customer’s payment method
  3. Add the credits to their balance

​
Configuration options

Auto-topup can be configured in two ways: Custom amount: Specify a fixed amount to charge and the number of credits to add when the threshold is reached. Bundle pricing: Use an existing bundle price from your product catalog. The system will automatically calculate the correct amount based on the bundle pricing.

Example 💡

If you want to add 200 credits and your bundle is 50 credits for €400, the system will charge €1,600 for 4 bundles.

​
Setting up auto-topup

When creating or updating a credit balance for a customer, you can configure:
  • The balance threshold that triggers auto-topup
  • The number of credits to add when triggered
  • Either a custom amount to charge, or select a bundle price from your catalog
Auto-topup requires the customer to have a valid payment method on file. If the payment fails, the topup will not be processed and the balance will remain unchanged.