Skip to main content
POST
/
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 balance = await client.balances.create({ customerId: 'x', name: 'x' });

console.log(balance.id);
{
  "id": "bal_abc123",
  "projectId": "proj_xyz",
  "customerId": "cust_123",
  "name": "credits",
  "unit": "credits",
  "currentBalance": 1000,
  "minimumBalance": 0,
  "dimensionFilters": {},
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

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

Minimum string length: 1
unit
string
default:credits

Unit (default: credits)

Minimum string length: 1
initialBalance
number
default:0

Initial balance (default: 0)

minimumBalance
number
default:0

Minimum balance (default: 0)

dimensionFilters
object

Dimension filters

Response

Balance created

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