Skip to main content
GET
/
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
});

// Automatically fetches more pages as needed.
for await (const balance of client.balances.list()) {
  console.log(balance.id);
}
{
  "data": [],
  "nextCursor": null,
  "hasMore": false
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
customerId
string

Filter by customer ID

​
limit
integer
default:50

Maximum number of items to return (1-100, default: 50)

Required range: 1 <= x <= 100
​
cursor
string

Pagination cursor from the previous response

Response

List of balances

​
data
object[]
required
​
nextCursor
string | null
required

Cursor for the next page of results. Null if there are no more results.

​
hasMore
boolean
required

Whether there are more results available