Postpaid account: credit limit, debt and available

GET

/billing/account

The credit limit set by Netts, your own overall limit, what you owe and how much you can spend now. Requires the billing.read key permission and a postpaid account.

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

The postpaid account.

Content-Type

application/json

{

  

"success": true,

  

"data": {

  

  

"mode": "string",

  

  

"adminLimit": {

  

  

},

  

  

"clientLimit": {

  

  

},

  

  

"effectiveAvailable": {

  

  

  

"unit": "string",

  

  

  

"value": "30000.000000"

  

  

},

  

  

"pendingUnbilled": {

  

  

},

  

  

"asOf": "string",

  

  

"settlement": {

  

  

},

  

  

"limit": {

  

  

  

"unit": "string",

  

  

  

"value": "30000.000000"

  

  

},

  

  

"unpaid": {

  

  

},

  

  

"creditUsdc": "string",

  

  

"available": "string",

  

  

"availableTrxEquiv": "string",

  

  

"availableUsdEquiv": "string",

  

  

"fx": {

  

  

  

"usdPerTrx": "0.33084276",

  

  

  

"at": "string"

  

  

},

  

  

"fxStatus": "string"

  

},

  

"timestamp": "string"

}

GET

/billing/account

Playground

Authorization

ApiKeyAuth

Headers

X-Real-IP*

Samples

Powered by VitePress OpenAPI