Skip to main content
GET
/
balances
/
{id}
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 balance = await client.balances.retrieve('id');

console.log(balance.id);
{
  "id": "<string>",
  "projectId": "<string>",
  "customerId": "<string>",
  "name": "<string>",
  "unit": "<string>",
  "currentBalance": 123,
  "minimumBalance": 123,
  "dimensionFilters": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Balance ID

Response

Balance found

Updated balance

id
string
required

Unique identifier for the balance

projectId
string
required

Project ID

customerId
string
required

Customer ID this balance belongs to

name
string
required

Balance name (e.g., "credits", "api_calls")

unit
string
required

Unit of the balance (e.g., "credits", "cents")

currentBalance
number
required

Current balance amount

minimumBalance
number
required

Minimum allowed balance (usually 0)

dimensionFilters
object
required

Dimension filters for scoping

createdAt
string<date-time>
required

Created timestamp

updatedAt
string<date-time>
required

Updated timestamp