Skip to content

All limits with used and available amounts​

GET
/billing/limits

Every limit of the account — set by Netts and your own — with used and available amounts, and how much each product can still spend. Requires billing.read.

Authorizations​

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type
API Key (header: X-API-KEY)

Parameters​

Header Parameters

X-Real-IP*

An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.

Type
string
Required
Example"203.0.113.10"
Format
"ipv4"

Responses​

Limits and available amounts per product.

application/json
JSON
{
  
"success": true,
  
"data": {
  
  
"limits": [
  
  
  
{
  
  
  
  
"id": 0,
  
  
  
  
"scope": "string",
  
  
  
  
"origin": "string",
  
  
  
  
"editable": true,
  
  
  
  
"canDisable": true,
  
  
  
  
"period": "string",
  
  
  
  
"productCode": "energy_5m",
  
  
  
  
"apiKeyId": 0,
  
  
  
  
"enabled": true,
  
  
  
  
"revision": 0,
  
  
  
  
"limit": {
  
  
  
  
  
"unit": "string",
  
  
  
  
  
"value": "30000.000000"
  
  
  
  
},
  
  
  
  
"equivalent": {
  
  
  
  
  
"unit": "string",
  
  
  
  
  
"value": "30000.000000"
  
  
  
  
},
  
  
  
  
"used": {
  
  
  
  
  
"unit": "string",
  
  
  
  
  
"value": "30000.000000"
  
  
  
  
},
  
  
  
  
"available": {
  
  
  
  
  
"unit": "string",
  
  
  
  
  
"value": "30000.000000"
  
  
  
  
},
  
  
  
  
"creditApplied": {
  
  
  
  
  
"unit": "string",
  
  
  
  
  
"value": "30000.000000"
  
  
  
  
},
  
  
  
  
"maxPerOrder": {
  
  
  
  
  
"unit": "string",
  
  
  
  
  
"value": "30000.000000"
  
  
  
  
},
  
  
  
  
"status": "string",
  
  
  
  
"periodStart": "string",
  
  
  
  
"periodEnd": "string",
  
  
  
  
"cappedBy": 0
  
  
  
}
  
  
],
  
  
"products": {
  
  
  
"additionalProperties": {
  
  
  
  
"unit": "string",
  
  
  
  
"spendable": "string",
  
  
  
  
"limitingLimitIds": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"maxPerOrder": "string",
  
  
  
  
"status": "string"
  
  
  
}
  
  
},
  
  
"unit": "string",
  
  
"asOf": "string",
  
  
"checkedApiKeyId": 0,
  
  
"valuationStatus": "string",
  
  
"creditUsdc": "string",
  
  
"fx": {
  
  
  
"usdPerTrx": "0.33084276",
  
  
  
"at": "string"
  
  
},
  
  
"fxStatus": "string"
  
},
  
"timestamp": "string"
}

Playground​

Authorization
Headers

Samples​

Powered by VitePress OpenAPI