Skip to main content
PUT
/
wallets
/
{id}
Update a wallet
curl --request PUT \
  --url https://api.cloud.flexprice.io/v1/wallets/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "alert_config": {
    "threshold": {
      "type": "<string>",
      "value": "<string>"
    }
  },
  "alert_enabled": true,
  "auto_topup": {
    "amount": 123,
    "enabled": true,
    "invoicing": true,
    "threshold": 123
  },
  "config": {
    "allowed_price_types": [
      "ALL"
    ]
  },
  "description": "<string>",
  "metadata": {},
  "name": "<string>"
}
'
{
  "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"
}

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

Body

application/json

Update wallet request

alert_config
object
alert_enabled
boolean
auto_topup
object
config
object
description
string
metadata
object
name
string

Response

OK

alert_config
object
alert_enabled
boolean
alert_state
string
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:
PROMOTIONAL,
PRE_PAID