Skip to main content
GET
/
customers
/
wallets
Get Customer Wallets
curl --request GET \
  --url https://us.api.flexprice.io/v1/customers/wallets \
  --header 'x-api-key: <api-key>'
[
  {
    "alert_settings": {
      "alert_enabled": true,
      "critical": {
        "condition": "above",
        "threshold": 123
      },
      "info": {
        "condition": "above",
        "threshold": 123
      },
      "warning": {
        "condition": "above",
        "threshold": 123
      }
    },
    "alert_state": "ok",
    "auto_topup": {
      "amount": 123,
      "enabled": true,
      "invoicing": true,
      "threshold": 123
    },
    "balance": "<string>",
    "config": {
      "allowed_price_types": [
        "ALL"
      ]
    },
    "conversion_rate": "<string>",
    "created_at": "<string>",
    "created_by": "<string>",
    "credit_balance": "<string>",
    "credits_available_breakdown": {
      "free": "<string>",
      "purchased": "<string>"
    },
    "currency": "<string>",
    "customer_id": "<string>",
    "description": "<string>",
    "environment_id": "<string>",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "status": "published",
    "tenant_id": "<string>",
    "topup_conversion_rate": "<string>",
    "updated_at": "<string>",
    "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>*

Query Parameters

​
-
integer

populated from x-max-live header, not query param

​
expand
string
​
from_cache
boolean
default:false
​
id
string
​
include_real_time_balance
boolean
default:false
​
lookup_key
string

Response

OK

​
alert_settings
object
​
alert_state
enum<string>
Available options:
ok,
info,
warning,
in_alarm
​
auto_topup
object
​
balance
string
​
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
​
created_by
string
​
credit_balance
string
​
credits_available_breakdown
object
​
currency
string
​
customer_id
string
​
description
string
​
environment_id
string
​
id
string
​
metadata
object
​
name
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

​
updated_at
string
​
updated_by
string
​
wallet_status
enum<string>
Available options:
active,
frozen,
closed
​
wallet_type
enum<string>
Available options:
PRE_PAID,
POST_PAID