Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Wallets

Update wallet settings

Update the global settings of the wallets.

patch/v1/wallets/settings

Request body

enabledboolean

Indicates if the wallet feature is enabled or not. If disabled, wallets won't be debited even if they are in active state and with money.

allow_free_creditsboolean

Allow top up for free amounts on wallets.

allow_topup_on_portalboolean

Allow wallet top up on customer's portal.

product_idsstring[]

Product IDs on which wallet will apply. If empty, the wallet will apply to all invoice line items.

Example request

{
  "enabled": true,
  "allow_free_credits": true,
  "product_ids": []
}

Response

enabledboolean required

Indicates if the wallet feature is enabled or not. If disabled, wallets won't be debited even if they are in active state and with money.

allow_free_creditsboolean required

Allow top up for free amounts on wallets.

allow_topup_on_portalboolean required

Allow wallet top up on customer's portal.

product_idsstring[] required

Product IDs on which wallet will apply. If empty, the wallet will apply to all invoice line items.

updated_atstring date-time nullable required

Last edition date of the wallet settings.

Example response

{
  "enabled": true,
  "allow_free_credits": true,
  "product_ids": [],
  "updated_at": "2024-12-20T16:04:11Z"
}