Get wallet balance

Use when displaying or checking current wallet balance (e.g. before charging or in a portal). Supports optional expand for credits breakdown and from_cache.

GET /wallets/{id}/balance/real-time

Get wallet balance

cURL

curl --request GET \
  --url https://us.api.flexprice.io/v1/wallets/{id}/balance/real-time \
  --header 'x-api-key: <api-key>'

200

{
  "alert_settings": {
    "alert_enabled": true,
    "critical": {
      "condition": "above",
      "threshold": "<string>"
    },
    "info": {
      "condition": "above",
      "threshold": "<string>"
    },
    "warning": {
      "condition": "above",
      "threshold": "<string>"
    }
  },
  "alert_state": "ok",
  "auto_topup": {
    "amount": 123,
    "cooldown": "3600000000000",
    "enabled": true,
    "invoicing": true,
    "threshold": 123
  },
  "balance": "<string>",
  "balance_updated_at": "2023-11-07T05:31:56Z",
  "config": {
    "allowed_price_types": [
      "ALL"
    ]
  },
  "conversion_rate": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "credit_balance": "<string>",
  "credits_available_breakdown": {
    "free": "<string>",
    "purchased": "<string>"
  },
  "currency": "<string>",
  "current_period_usage": "<string>",
  "customer_id": "<string>",
  "description": "<string>",
  "environment_id": "<string>",
  "id": "<string>",
  "is_cached_fallback": true,
  "metadata": {},
  "name": "<string>",
  "real_time_balance": "<string>",
  "real_time_credit_balance": "<string>",
  "status": "published",
  "tenant_id": "<string>",
  "topup_conversion_rate": "<string>",
  "unpaid_invoices_amount": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "wallet_status": "active",
  "wallet_type": "PRE_PAID"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id · string · required

Wallet ID

Query Parameters

expand · string

Expand fields (e.g., credits_available_breakdown)

Response

200

application/json

OK

alert_settings · object

Show child attributes

alert_state · enum<string>

Available options: ok, info, warning, in_alarm

auto_topup · object

Show child attributes

balance · string

balance_updated_at · string<date-time>

config · object

Show child attributes

conversion_rate · string

amount in the currency = number of credits * conversion_rate ex if conversion_rate is 1, then 1 USD = 1 credit ex if conversion_rate is 2, then 1 USD = 0.5 credits ex if conversion_rate is 0.5, then 1 USD = 2 credits

created_at · string<date-time>

created_by · string

credit_balance · string

credits_available_breakdown · object

Show child attributes

currency · string

current_period_usage · string

customer_id · string

description · string

environment_id · string

id · string

is_cached_fallback · boolean

IsCachedFallback is true whenever the response is sourced from cache: either an explicit cache request, or fallback after a real-time failure. Clients should treat the absence of this field as if it were true and only trust freshness when the server explicitly emits false.

metadata · object

Show child attributes

name · string

real_time_balance · string

real_time_credit_balance · string

status · enum<string>

Available options: published, deleted, archived

tenant_id · string

topup_conversion_rate · string

topup_conversion_rate is the conversion rate for the topup to the currency ex if topup_conversion_rate is 1, then 1 USD = 1 credit ex if topup_conversion_rate is 2, then 1 USD = 0.5 credits ex if topup_conversion_rate is 0.5, then 1 USD = 2 credits

unpaid_invoices_amount · string

updated_at · string<date-time>

updated_by · string

wallet_status · enum<string>

Available options: active, frozen, closed

wallet_type · enum<string>

Available options: PRE_PAID, POST_PAID