Skip to content

Switch your own limit off​

POST
/billing/limits/{limitId}/disable

The limit stops applying and stays in the list with enabled false. Debt and charges are not affected. Requires limits.write and an Idempotency-Key header.

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"
Idempotency-Key*

A unique string, 8–128 characters, one per change. A retry with the same key and body returns the original answer and does not repeat the change.

Type
string
Required
Min Length
8
Max Length
128

Path Parameters

limitId*

The limit id from GET /billing/limits.

Type
integer
Required

Query Parameters

scope*

Always account for your own limits.

Type
string
Required
Valid values
"account"

Request Body​

application/json
JSON
{
  
"expectedRevision": 0
}

Responses​

The limit is switched off.

application/json
JSON
{
  
"success": true,
  
"data": {
  
  
"id": 0,
  
  
"scope": "string",
  
  
"origin": "string",
  
  
"productCode": "string",
  
  
"period": "string",
  
  
"enabled": true,
  
  
"limit": {
  
  
  
"unit": "string",
  
  
  
"value": "30000.000000"
  
  
},
  
  
"equivalent": {
  
  
  
"unit": "string",
  
  
  
"value": "30000.000000"
  
  
},
  
  
"revision": 0,
  
  
"fx": {
  
  
  
"usdPerTrx": "0.33084276",
  
  
  
"at": "string"
  
  
},
  
  
"fxStatus": "string"
  
},
  
"timestamp": "string"
}

Playground​

Authorization
Headers
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI