Get current account limits

Returns the customer's current account limits and remaining headroom, one entry per provider.

used and remaining reflect the customer's activity to date and the endpoint is safe to poll — for example right after a limit request is reviewed. limit, used and remaining are decimal strings, never JSON numbers, with at least the currency's decimal places ("30000.00" for USD); a value the provider reports more precisely is never rounded.

Limits are reported only for an individual customer, and only for providers where that customer's onboarding is ACTIVE and account limits are supported. Everything else is an empty data array, not an error: a business customer, an individual still onboarding (or whose account is no longer active), and a provider without account-limit support all return 200 {"data": []} — including when that provider is named in ?provider=. Only an unknown ?provider= slug returns 400. Entries are ordered by provider.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string

Restrict the read to one provider. A configured provider with no limits for this customer yields an empty data array.

Headers
string
required

Your API key

string
required

Request timestamp (ISO 8601 UTC), included in the signature payload

string
required

Unique request nonce (e.g. UUID)

string
required

HMAC-SHA256 hex digest of {METHOD}\n{path}\n{query}\n{X-Timestamp}\n{body}, signed with your API secret. Path excludes the query string; use an empty string for query/body when absent.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json