Create top-up by external ID
This endpoint allows you to create a new top-up for a specified customer’s balance. While this top-up is active, the customer’s balance will added in increments of the specified amount whenever the balance reaches the specified threshold.
If a top-up already exists for this customer in the same currency, the existing top-up will be replaced.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Body
The amount to increment when the threshold is reached.
The currency or custom pricing unit to use for this top-up. If this is a real-world currency, it must match the customer's invoicing currency.
Settings for invoices generated by triggered top-ups.
How much, in the customer's currency, to charge for each unit.
The threshold at which to trigger the top-up. If the balance is at or below this threshold, the top-up will be triggered.
The number of days or months after which the top-up expires. If unspecified, it does not expire.
The unit of expires_after.
day, month Response
The amount to increment when the threshold is reached.
The currency or custom pricing unit to use for this top-up. If this is a real-world currency, it must match the customer's invoicing currency.
Settings for invoices generated by triggered top-ups.
How much, in the customer's currency, to charge for each unit.
The threshold at which to trigger the top-up. If the balance is at or below this threshold, the top-up will be triggered.
The number of days or months after which the top-up expires. If unspecified, it does not expire.
The unit of expires_after.
day, month Was this page helpful?