Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Body
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.
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 amount to increment when the threshold is reached.
How much, in the customer's currency, to charge for each unit.
Settings for invoices generated by triggered top-ups.
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
The date from which the top-up is active. If unspecified, the top-up is active immediately. This should not be more than 10 days in the past.
Response
Created
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.
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 amount to increment when the threshold is reached.
How much, in the customer's currency, to charge for each unit.
Settings for invoices generated by triggered top-ups.
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