Skip to content
Hayonix

API reference · Schema

Balance

Amounts are integer nano-USD as decimal strings

  • objectstringrequired

    Always `balance`: the type of this object

    One ofbalance

  • org_idstringrequired

    Organization it belongs to

    ID with prefix org_

  • currencystringrequired

    Always `usd`

    One ofusd

  • paidstringrequired

    Paid credit; negative when overdrawn

    pattern ^-?[0-9]+$

  • promostringrequired

    Spendable promotional credit

    pattern ^-?[0-9]+$

  • heldstringrequired

    Reserved by in-flight work

    pattern ^-?[0-9]+$

  • availablestringrequired

    paid + promo: what new work may use

    pattern ^-?[0-9]+$

  • as_ofstring (date-time)required

    When these amounts were read (ISO 8601, UTC)

Example
{
  "object": "balance",
  "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "currency": "usd",
  "paid": "1500000000",
  "promo": "1500000000",
  "held": "1500000000",
  "available": "1500000000",
  "as_of": "2026-01-01T00:00:00.000Z"
}

Used by