Get monthly charges summary
Retrieve a summary of monthly charges for a specified date range. The date range cannot exceed 31 days.
get/charges_summary
Query parameters
start_datestring date required
Example:2025-05-01
Start date for the charges summary in ISO date format (YYYY-MM-DD)
end_datestring date required
Example:2025-06-01
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.
Response
Monthly charges summary
Example response
{
"data": {
"currency": "USD",
"end_date": "2025-06-01",
"start_date": "2025-05-01",
"summary": {
"adjustments": [
{
"amount": "-10.00",
"description": "Credit for service outage",
"event_date": "2025-05-15"
}
],
"lines": [
{
"alias": "local",
"existing_this_month": {
"mrc": "20.00",
"quantity": 8
},
"name": "Local DIDs",
"new_this_month": {
"mrc": "25.50",
"otc": "5.00",
"quantity": 10
},
"type": "comparative"
},
{
"alias": "port_out",
"amount": "15.75",
"name": "Port Out",
"quantity": 100,
"type": "simple"
}
]
},
"total": {
"credits": "-5.00",
"existing_mrc": "100.00",
"grand_total": "180.00",
"ledger_adjustments": "0.00",
"new_mrc": "50.00",
"new_otc": "25.00",
"other": "10.00"
},
"user_email": "user@example.com",
"user_id": "0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8"
}
}