Skip to main content
POST
/
balances
/
check
JavaScript
import Limitry from '@limitry/sdk';

const client = new Limitry({
  apiKey: process.env['LIMITRY_API_KEY'], // This is the default and can be omitted
});

const response = await client.balances.checkSufficiency({
  amount: 1,
  customerId: 'x',
  name: 'x',
});

console.log(response.availableBalance);
{
  "balanceId": "bal_abc123",
  "name": "credits",
  "unit": "credits",
  "currentBalance": 1000,
  "minimumBalance": 0,
  "requestedAmount": 100,
  "sufficient": true,
  "availableBalance": 1000
}

Authorizations

​
Authorization
string
header
required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Body

application/json
​
customerId
string
required

Customer ID

Minimum string length: 1
​
name
string
required

Balance name to check

Minimum string length: 1
​
amount
number
required

Amount to check

Required range: x > 0
​
dimensions
object

Dimension filters

Response

Balance check result

​
balanceId
string
required

Balance ID

​
name
string
required

Balance name

​
unit
string
required

Balance unit

​
currentBalance
number
required

Current balance

​
minimumBalance
number
required

Minimum balance

​
requestedAmount
number
required

Amount checked

​
sufficient
boolean
required

Whether balance is sufficient

​
availableBalance
number
required

Available balance (current - minimum)