Skip to main content
PUT
Set Account Daily Spending Limit

Body

application/json
amount
integer<int64>
required

Daily limit in the currency's smallest unit (e.g. cents for USD). For USD: send 1000 to set a $10.00 limit, send 1000000 to set the $10,000.00 cap. Must be in (0, 1,000,000].

Required range: 1 <= x <= 1000000
currency
string
required

ISO-4217 currency code. Only USD is currently accepted.

Response

The request has succeeded.

amount
integer<int64>
required

Daily limit in the currency's smallest unit (e.g. cents for USD). Divide by 10^decimals to get the major-unit value. For USD (decimals=2): amount=1000 means $10.00, amount=1000000 means $10,000.00.

currency
string
required

ISO-4217 currency code, e.g. USD.

decimals
integer<int32>
required

Number of decimal places for this currency (e.g. 2 for USD).

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 the currency's smallest unit (e.g. cents for USD). Resets at the start of each calendar day.

remaining
integer<int64>
required

Remaining headroom today, in the currency's smallest unit. Equals max(0, amount - spentToday).