SerenAI

Pay Per Call Agentic Commerce

WalletBalanceResponse

Wallet balance response (funded + promotional)

Properties

PropertyTypeRequiredDescription
balance_atomic integer Yes Total wallet balance in atomic units
balance_usd string Yes
by_source Array<WalletSourceBalance> Yes Breakdown by source
funded_balance_atomic integer Yes Total funded balance (fiat purchases + tier bonuses)
funded_balance_usd string Yes
has_recovery boolean Yes Whether recovery is set up for this account
promotional_balance_atomic integer Yes Total promotional balance (bonuses, daily claims, referrals, admin grants)
promotional_balance_usd string Yes
recovery_warning string,null No Warning if funds exist but no recovery is set up
total_purchases_cents integer Yes Total lifetime SerenBucks purchases in cents (for plan upgrade tracking)
total_purchases_usd string Yes
wallet_address string Yes
View JSON Schema
{
  "type": "object",
  "description": "Wallet balance response (funded + promotional)",
  "required": [
    "wallet_address",
    "balance_atomic",
    "balance_usd",
    "funded_balance_atomic",
    "funded_balance_usd",
    "promotional_balance_atomic",
    "promotional_balance_usd",
    "by_source",
    "total_purchases_cents",
    "total_purchases_usd",
    "has_recovery"
  ],
  "properties": {
    "balance_atomic": {
      "type": "integer",
      "format": "int64",
      "description": "Total wallet balance in atomic units"
    },
    "balance_usd": {
      "type": "string"
    },
    "by_source": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WalletSourceBalance"
      },
      "description": "Breakdown by source"
    },
    "funded_balance_atomic": {
      "type": "integer",
      "format": "int64",
      "description": "Total funded balance (fiat purchases + tier bonuses)"
    },
    "funded_balance_usd": {
      "type": "string"
    },
    "has_recovery": {
      "type": "boolean",
      "description": "Whether recovery is set up for this account"
    },
    "promotional_balance_atomic": {
      "type": "integer",
      "format": "int64",
      "description": "Total promotional balance (bonuses, daily claims, referrals, admin grants)"
    },
    "promotional_balance_usd": {
      "type": "string"
    },
    "recovery_warning": {
      "type": [
        "string",
        "null"
      ],
      "description": "Warning if funds exist but no recovery is set up"
    },
    "total_purchases_cents": {
      "type": "integer",
      "format": "int64",
      "description": "Total lifetime SerenBucks purchases in cents (for plan upgrade tracking)"
    },
    "total_purchases_usd": {
      "type": "string"
    },
    "wallet_address": {
      "type": "string"
    }
  }
}