Balance lifecycle
Get Balance
Use
available as the spendable balance. A submit will be rejected with 402 Insufficient Credits when the request cost exceeds available, even if credits alone would cover it.Top Up
credits once Stripe confirms the payment.
number
required
Amount in USD to add to your balance.
Coupons
Coupons are prepaid credit codes. Redeeming one adds its value to your balance — a top-up without a card, recorded like any other transaction (payment_method: "coupon").
Coupons are issued directly by RouterBase (promotions, credits, enterprise arrangements). To request one, contact us at [email protected].
Redeem a Coupon
string
required
The coupon code you received (e.g.
A1B2-C3D4-E5F6).Response
A coupon can be redeemed once.
You can also redeem a coupon from the Billing page in the dashboard — enter it in the “Redeem Coupon” box.
Transaction History
held) are not listed here — they aren’t transactions until the generation finishes.
Query Parameters
number
Page number. Default:
1.number
Results per page. Default:
20.Response
Balance Alerts
Create Alert
number
required
Receive an email when
credits drops below this amount.