Skip to main content
GET
/
charges_summary
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const chargesSummary = await client.chargesSummary.retrieve({
  end_date: '2025-06-01',
  start_date: '2025-05-01',
});

console.log(chargesSummary.data);
{
  "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",
    "summary": {
      "lines": [
        {
          "type": "comparative",
          "name": "Local DIDs",
          "alias": "local",
          "new_this_month": {
            "quantity": 10,
            "mrc": "25.50",
            "otc": "5.00"
          },
          "existing_this_month": {
            "quantity": 8,
            "mrc": "20.00"
          }
        },
        {
          "type": "simple",
          "name": "Port Out",
          "alias": "port_out",
          "quantity": 100,
          "amount": "15.75"
        }
      ],
      "adjustments": [
        {
          "amount": "-10.00",
          "description": "Credit for service outage",
          "event_date": "2025-05-15"
        }
      ]
    },
    "total": {
      "new_mrc": "50.00",
      "new_otc": "25.00",
      "existing_mrc": "100.00",
      "other": "10.00",
      "credits": "-5.00",
      "ledger_adjustments": "0.00",
      "grand_total": "180.00"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

start_date
string<date>
required

Start date for the charges summary in ISO date format (YYYY-MM-DD)

Example:

"2025-05-01"

end_date
string<date>
required

End date for the charges summary in ISO date format (YYYY-MM-DD). 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

Monthly charges summary

data
object
required