Sign in

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

Query parameters

start_datestring date required
Example:2025-05-01

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

end_datestring date
Example:2025-06-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.

format'json' | 'csv'
Example:json

Response format

Response

Monthly charges breakdown

Example response

{
  "data": {
    "currency": "USD",
    "end_date": "2025-06-01",
    "results": [
      {
        "charge_type": "local",
        "service_owner_email": "user@example.com",
        "service_owner_user_id": "0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8",
        "services": [
          {
            "cost": "1.50",
            "cost_type": "MRC",
            "name": "Local DIDs"
          }
        ],
        "tn": "+15551234567"
      }
    ],
    "start_date": "2025-05-01",
    "user_email": "user@example.com",
    "user_id": "0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8"
  }
}

Changes

Changed in 2 of the 61 revisions of this API.7

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status default

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from object/ to / for status default

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/integer for status default

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379944See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status default

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/integer to integer/int32 for status default

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status default

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog