Get user balance details

GET /balance

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

const balance = await client.balance.retrieve();

console.log(balance.data);

200

{
  "data": {
    "record_type": "balance",
    "pending": "10.00",
    "balance": "300.00",
    "credit_limit": "100.00",
    "available_credit": "400.00",
    "currency": "USD"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

Get user balance details

data · object

Show child attributes

Example:

{
  "record_type": "balance",
  "pending": "10.00",
  "balance": "300.00",
  "credit_limit": "100.00",
  "available_credit": "400.00",
  "currency": "USD"
}