Billing

Billing operations

Retrieve user balance details

SecuritybearerAuth
Responses
200

Retrieve user balance details

Response Schema: application/json
object (UserBalance)
available_credit
string <decimal>

Available amount to spend (balance + credit limit)

balance
string <decimal>

The account's current balance.

credit_limit
string <decimal>

The account's credit limit.

currency
string <iso4217>

The ISO 4217 currency identifier.

record_type
string

Identifies the type of the resource.

Value: "balance"
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/balance
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.Balance.retrieve()
Response samples
application/json
{
  • "data": {
    • "available_credit": "400.00",
    • "balance": "300.00",
    • "credit_limit": "100.00",
    • "currency": "USD",
    • "record_type": "balance"
    }
}