Skip to main content
GET
/
customers
/
{id}
/
spending-limit
Get customer spending limit usage
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/customers/{id}/spending-limit \
  --header 'X-API-Key: <api-key>'
{
  "crypto_offramp": {
    "period_end": "2023-11-07T05:31:56Z",
    "period_start": "2023-11-07T05:31:56Z",
    "used_eur": "<string>",
    "remaining_eur": "<string>",
    "threshold_eur": "<string>"
  },
  "fiat_onramp": {
    "period_end": "2023-11-07T05:31:56Z",
    "period_start": "2023-11-07T05:31:56Z",
    "used_eur": "<string>",
    "remaining_eur": "<string>",
    "threshold_eur": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner

Path Parameters

​
id
string<uuid>
required

the ID of the Customer to GET the spending limit for

Response

GET Customer Spending Limit Succeeded

Customer Spending Limit

Current usage of the rolling 52-week spending limit split by direction.

​
crypto_offramp
CustomerSpendingLimitSection · object
required

Customer Spending Limit Section

Usage of the rolling 52-week spending limit for a single direction (fiat on-ramp or crypto off-ramp).

Amounts are returned in EUR cents as strings

threshold_eur (and therefore remaining_eur) is null when the customer has no enforced cap — for example Business customers or persons with ThresholdKind::Regulated. A null threshold does not mean "unknown";

​
fiat_onramp
CustomerSpendingLimitSection · object
required

Customer Spending Limit Section

Usage of the rolling 52-week spending limit for a single direction (fiat on-ramp or crypto off-ramp).

Amounts are returned in EUR cents as strings

threshold_eur (and therefore remaining_eur) is null when the customer has no enforced cap — for example Business customers or persons with ThresholdKind::Regulated. A null threshold does not mean "unknown";