Skip to main content
GET
/
customers
/
{id}
/
balances
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.customers.getBalances('id');

console.log(response.balances);
{
  "balances": [
    {
      "id": "bal_abc123",
      "name": "credits",
      "unit": "credits",
      "currentBalance": 1000,
      "minimumBalance": 0,
      "availableBalance": 1000
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Customer ID

Response

Customer balances

balances
object[]
required

Customer balances