Skip to main content
GET
/
wallets
/
{id}
/
balance
/
real-time
Get wallet balance
curl --request GET \
  --url https://us.api.flexprice.io/v1/wallets/{id}/balance/real-time \
  --header 'x-api-key: <api-key>'
{
  "alert_settings": {
    "alert_enabled": true,
    "critical": {
      "threshold": 123
    },
    "info": {
      "threshold": 123
    },
    "warning": {
      "threshold": 123
    }
  },
  "auto_topup": {
    "amount": 123,
    "enabled": true,
    "invoicing": true,
    "threshold": 123
  },
  "balance": "<string>",
  "balance_updated_at": "2023-11-07T05:31:56Z",
  "config": {
    "allowed_price_types": []
  },
  "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>",
  "metadata": {},
  "name": "<string>",
  "real_time_balance": "<string>",
  "real_time_credit_balance": "<string>",
  "tenant_id": "<string>",
  "topup_conversion_rate": "<string>",
  "unpaid_invoices_amount": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt

Use this file to discover all available pages before exploring further.

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

OK

​
alert_settings
object
​
alert_state
enum<string>
Available options:
ok,
info,
warning,
in_alarm
​
auto_topup
object
​
balance
string
​
balance_updated_at
string<date-time>
​
config
object
​
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
​
currency
string
​
current_period_usage
string
​
customer_id
string
​
description
string
​
environment_id
string
​
id
string
​
metadata
object
​
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