GET
/
wallets
/
{id}
/
balance
/
real-time
curl --request GET \
  --url https://api.cloud.flexprice.io/v1/wallets/{id}/balance/real-time \
  --header 'x-api-key: <api-key>'
{
  "auto_topup_amount": 123,
  "auto_topup_min_balance": 123,
  "auto_topup_trigger": "disabled",
  "balance": 123,
  "balance_updated_at": "<string>",
  "config": {
    "allowed_price_types": [
      "ALL"
    ]
  },
  "conversion_rate": 123,
  "created_at": "<string>",
  "created_by": "<string>",
  "credit_balance": 123,
  "currency": "<string>",
  "current_period_usage": 123,
  "customer_id": "<string>",
  "description": "<string>",
  "environment_id": "<string>",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "real_time_balance": 123,
  "real_time_credit_balance": 123,
  "status": "published",
  "tenant_id": "<string>",
  "unpaid_invoice_amount": 123,
  "updated_at": "<string>",
  "updated_by": "<string>",
  "wallet_status": "active",
  "wallet_type": "PROMOTIONAL"
}

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

Response

200
application/json
OK
​
auto_topup_amount
number
​
auto_topup_min_balance
number
​
auto_topup_trigger
enum<string>
Available options:
disabled,
balance_below_threshold
​
balance
number
​
balance_updated_at
string
​
config
object
​
conversion_rate
number
​
created_at
string
​
created_by
string
​
credit_balance
number
​
currency
string
​
current_period_usage
number
​
customer_id
string
​
description
string
​
environment_id
string
​
id
string
​
metadata
object
​
name
string
​
real_time_balance
number
​
real_time_credit_balance
number
​
status
enum<string>
Available options:
published,
deleted,
archived
​
tenant_id
string
​
unpaid_invoice_amount
number
​
updated_at
string
​
updated_by
string
​
wallet_status
enum<string>
Available options:
active,
frozen,
closed
​
wallet_type
enum<string>
Available options:
PROMOTIONAL,
PRE_PAID