Using the interface
Using the API
Add credits to an existing wallet
There are 3 ways paid credits can be added to a customer’s wallet:
- You can either add paid credits through Hyperline yourself (after discussing with your customer and agreeing on an amount)
- Customers can also top up their account themselves through their customer portal
- Credits can be added through the API
Adding credits for your customer in Hyperline
Once you created a wallet for your customer:
Click on Add credits
Customers must have an active credit card to be able to add paid credits to their wallet.
Here you can choose between paid or free credits.
Paid credits are credits your customer paid (or will pay) for. Free credits are an offer you are making to the customer (they will be given to them for free).
Click again on Add credits when you're done
Invoices for credits
One-off invoices are generated when users buy credits. As credits are bought through credit cards, an invoice is generated at the time of the buy and automatically paid right away.
Adding credits from a customer’s portal
You can make your customers autonomous by offering them to buy credits through their portal.
Make sure you enabled the option
For this, you have to go to the wallet settings first.
It is currently not possible to add more than $100 in one payment to a wallet, and the total balance of a wallet can’t be more than $500 for payments made through a customer portal.
Paid credits added through Hyperline have no limitations.
Your customers are now able to buy credits from their portal
They will be required to add a credit card as a payment method to do so.
Your customers must choose how many credits they want to buy
Clicking on Buy credits on this screen will trigger an immediate payment from the registered credit card and credit the wallets instantly.
The corresponding invoice is now created and visible on the portal
Invoices can be downloaded as PDF by the customer.
Customers wallets are automatically debited when the feature is enabled (wallet settings configured) and if there is money on it. They are used to pay subscriptions, related invoices and one-time payments.
A wallet cannot have a negative balance.
We make sure to take the maximum amount of money from wallets when paying invoices, but the potential remaining part to pay will be processed with the default customer payment method (the one saved).
An invoice can have multiple debit methods, e.g. wallet + credit card, and this will be displayed on the final generated PDF invoice.
Wallet balance & projection
Wallet balance are computed in real time in Hyperline.
In addition to the wallet balance, we also compute and return a projected balance. This balance take into account a projection of the future remaining money on the wallet after paying what will be due in the current period (subscription, usage). This is particularly useful for a pay-as-you-go use case when you want to restrain access to your product if the customer doesn’t have enough prepaid credits.