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": {
    "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"
          }
        ]
      }
    ]
  }
}

Changes

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

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to integer for status

      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 changed from no type to object for status

      response-body-type-changed

    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from integer to int32 for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      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

Of the 99 revisions, 1 has no diff computed.