TAtalkdesk
Billing Insights API

Returns a collection of usage data aggregated by month.

Changed on

All the usage data will be returned for the accounts under the organization. The data is aggegated by month for each product. A 403 error is returned if the specified accounts are not under the organization performing the call. The results are paged.

get/express/usage/month

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/express/usage/month
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: express-accounts-usage:read

Query parameters

pageinteger
Example:1

The number of the page to be returned. The default value is 1.

per_pageinteger

The number of results to be returned per page. The default value is 50.

filterstring

Allows filtering the results by 'account_id', 'month' or 'id' using comparison or logical operators. Examples:

  • Returns the data for a specific account
accound_id eq '5ea75fe7aa224700012eae40'
  • Returns the data for a set of given accounts
account_id eq '5ea75fe7aa224700012eae40' or account_id eq '4ae75fe7aa224700012eae29'
  • Returns the data for a given account and specific month
(month eq '2003-12' and account_id eq '5ea75fe7aa224700012eae40')
order_bystring

Allows ordering the results by 'id', 'account_id' or 'month'

Response

successful operation

Example response

{
  "_embedded": {
    "usage": [
      {
        "id": "8f3e643c16671acaf60e8bceddbc1877",
        "account_id": "5ea75fe7aa224700012eae40",
        "product_id": "TD-LIC-APP-RC-101910",
        "aggr_product_id": "TD-USG-TEL-UG-102213",
        "month": "2023-08",
        "type": "NUMBER",
        "description": "SIP Number",
        "currency": "USD",
        "direction": "INBOUND",
        "unit": "MINUTES",
        "price": 1,
        "wallet_name": "contact center",
        "number_of_units": 5,
        "total_amount": 5
      }
    ]
  }
}

Changes