Skip to main content
Retrieve the current credit balance for a billing account. This is useful for prepaid or credit-based billing systems.
curl -X GET "https://frontier.example.com/v1beta1/organizations/{org_id}/billing/{id}/balance" \
  -H "Authorization: Bearer <token>"
{
  "balance": {
    "amount": 10000,
    "currency": "VC"
  }
}

Balance Object

balance
object
The balance information for the billing account.

Usage Notes

  • The balance amount is returned in the smallest unit (e.g., 10000 represents 100.00 in standard currency)
  • For virtual credit systems, the currency is “VC” and represents available credits
  • A negative balance may indicate debt or usage beyond prepaid credits
  • Balance updates occur when:
    • Credits are purchased or added
    • Usage is recorded
    • Refunds are processed
    • Adjustments are made by administrators

Build docs developers (and LLMs) love