Get monthly charges breakdown
Retrieve a detailed breakdown of monthly charges for phone numbers in a specified date range. The date range cannot exceed 31 days.
GET
/
charges_breakdown
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const chargesBreakdown = await client.chargesBreakdown.retrieve({ start_date: '2025-05-01' });
console.log(chargesBreakdown.data);import os
from datetime import date
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
charges_breakdown = client.charges_breakdown.retrieve(
start_date=date.fromisoformat("2025-05-01"),
)
print(charges_breakdown.data)
package main
import (
"context"
"fmt"
"time"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
chargesBreakdown, err := client.ChargesBreakdown.Get(context.TODO(), telnyx.ChargesBreakdownGetParams{
StartDate: time.Now(),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", chargesBreakdown.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.chargesbreakdown.ChargesBreakdownRetrieveParams;
import com.telnyx.sdk.models.chargesbreakdown.ChargesBreakdownRetrieveResponse;
import java.time.LocalDate;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
ChargesBreakdownRetrieveParams params = ChargesBreakdownRetrieveParams.builder()
.startDate(LocalDate.parse("2025-05-01"))
.build();
ChargesBreakdownRetrieveResponse chargesBreakdown = client.chargesBreakdown().retrieve(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
charges_breakdown = telnyx.charges_breakdown.retrieve(start_date: "2025-05-01")
puts(charges_breakdown)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$chargesBreakdown = $client->chargesBreakdown->retrieve(
startDate: '2025-05-01', endDate: '2025-06-01', format: 'json'
);
var_dump($chargesBreakdown);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx charges-breakdown retrieve \
--api-key 'My API Key' \
--start-date "'2025-05-01'"curl --request GET \
--url https://api.telnyx.com/v2/charges_breakdown \
--header 'Authorization: Bearer <token>'{
"data": {
"user_id": "0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8",
"start_date": "2025-05-01",
"end_date": "2025-06-01",
"user_email": "user@example.com",
"currency": "USD",
"results": [
{
"tn": "+15551234567",
"charge_type": "local",
"service_owner_user_id": "0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8",
"service_owner_email": "user@example.com",
"services": [
{
"cost_type": "MRC",
"name": "Local DIDs",
"cost": "1.50"
}
]
}
]
}
}{
"errors": [
{
"code": "10015",
"title": "Bad Request",
"detail": "The request failed because it was not well-formed."
}
]
}{
"errors": [
{
"code": "10027",
"title": "Unprocessable Entity",
"detail": "The server understood the syntax of the request but was unable to process the instructions."
}
]
}{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured."
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Start date for the charges breakdown in ISO date format (YYYY-MM-DD)
Example:
"2025-05-01"
End date for the charges breakdown in ISO date format (YYYY-MM-DD). If not provided, defaults to start_date + 1 month. The date is exclusive, data for the end_date itself is not included in the report. The interval between start_date and end_date cannot exceed 31 days.
Example:
"2025-06-01"
Response format
Available options:
json, csv Example:
"json"
Response
Monthly charges breakdown
Show child attributes
Show child attributes
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const chargesBreakdown = await client.chargesBreakdown.retrieve({ start_date: '2025-05-01' });
console.log(chargesBreakdown.data);import os
from datetime import date
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
charges_breakdown = client.charges_breakdown.retrieve(
start_date=date.fromisoformat("2025-05-01"),
)
print(charges_breakdown.data)
package main
import (
"context"
"fmt"
"time"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
chargesBreakdown, err := client.ChargesBreakdown.Get(context.TODO(), telnyx.ChargesBreakdownGetParams{
StartDate: time.Now(),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", chargesBreakdown.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.chargesbreakdown.ChargesBreakdownRetrieveParams;
import com.telnyx.sdk.models.chargesbreakdown.ChargesBreakdownRetrieveResponse;
import java.time.LocalDate;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
ChargesBreakdownRetrieveParams params = ChargesBreakdownRetrieveParams.builder()
.startDate(LocalDate.parse("2025-05-01"))
.build();
ChargesBreakdownRetrieveResponse chargesBreakdown = client.chargesBreakdown().retrieve(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
charges_breakdown = telnyx.charges_breakdown.retrieve(start_date: "2025-05-01")
puts(charges_breakdown)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$chargesBreakdown = $client->chargesBreakdown->retrieve(
startDate: '2025-05-01', endDate: '2025-06-01', format: 'json'
);
var_dump($chargesBreakdown);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx charges-breakdown retrieve \
--api-key 'My API Key' \
--start-date "'2025-05-01'"curl --request GET \
--url https://api.telnyx.com/v2/charges_breakdown \
--header 'Authorization: Bearer <token>'{
"data": {
"user_id": "0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8",
"start_date": "2025-05-01",
"end_date": "2025-06-01",
"user_email": "user@example.com",
"currency": "USD",
"results": [
{
"tn": "+15551234567",
"charge_type": "local",
"service_owner_user_id": "0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8",
"service_owner_email": "user@example.com",
"services": [
{
"cost_type": "MRC",
"name": "Local DIDs",
"cost": "1.50"
}
]
}
]
}
}{
"errors": [
{
"code": "10015",
"title": "Bad Request",
"detail": "The request failed because it was not well-formed."
}
]
}{
"errors": [
{
"code": "10027",
"title": "Unprocessable Entity",
"detail": "The server understood the syntax of the request but was unable to process the instructions."
}
]
}{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured."
}
]
}