Skip to main content
PUT
Set Account Daily Spending Limit

Body

application/json
amount
integer<int64>
required

Daily spending limit in minor units of currency. USD, EUR, and GBP use 2 decimal places, so 1000000 is 10,000.00.

Required range: x >= 1
Example:

1000000

currency
string
required

ISO-4217 currency code. Must match the account native currency (nativeCurrency from GET /user/account).

Example:

"EUR"

Response

The request has succeeded.

amount
integer<int64>
required

Daily limit in minor units of currency. Divide by 10^decimals to get the major-unit value. USD, EUR, and GBP use 2 decimal places.

currency
string
required

ISO-4217 currency code — the account native currency (nativeCurrency from GET /user/account).

decimals
integer<int32>
required

Number of decimal places for this currency (2 for USD, EUR, and GBP).

syncStatus
enum<string>
required

Replication state of the limit. pending immediately after an update, synced once the change has been applied, failed if the change could not be applied after retries.

Available options:
pending,
synced,
failed
updatedAt
string<date-time>
required

Last time this limit was modified.

spentToday
integer<int64>
required

Amount spent today against this limit, in minor units of currency. Resets at the start of each calendar day.

remaining
integer<int64>
required

Remaining headroom today, in minor units of currency. Equals max(0, amount - spentToday).