Skip to main content
GET
Get an account spending limit

Path Parameters

account_id
string<uuid>
required

The account ID.

Response

The request has succeeded.

amount
integer<int64>
required

Configured daily limit in the currency's smallest unit.

currency
string
required

ISO-4217 currency code.

decimals
integer<int32>
required

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

sync_status
enum<string>
required

Application status of the limit. pending means the update is still being applied, synced means it is active, and failed means it could not be applied.

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

Last time this limit was modified.

spent_today
integer<int64>
required

Eligible card spending counted against this limit since 00:00 UTC, summed across all cards on the account and expressed in the currency's smallest unit.

remaining
integer<int64>
required

Remaining headroom for today, in the currency's smallest unit. Equal to max(0, amount - spent_today).