Skip to main content
GET
/
wallets
List wallets
curl --request GET \
  --url https://api.cloud.flexprice.io/v1/wallets \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "alert_config": {
        "threshold": {
          "type": "amount",
          "value": 123
        }
      },
      "alert_enabled": true,
      "alert_state": "<string>",
      "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": "PROMOTIONAL"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

x-api-key
string
header
required

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

Query Parameters

alert_enabled
boolean
expand
string

Expand fields (e.g., credits_available_breakdown)

limit
integer
Required range: 1 <= x <= 1000
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
sort
string
status
enum<string>
Available options:
active,
frozen,
closed
wallet_ids
string[]

Response

OK

items
object[]
pagination
object