GET /employee/consumption

This version of the API is deprecated and will stop working from February 1, 2015, please see API v2

Get consumption information for the authenticated employee. This is only relevant for users with a mobile subscription - otherwise an empty JSON object is returned.

Response

period.begin_at
Beginning of this billing period
period.end_at
End of this billing period
speak.usage
Number of seconds utilized for this period to date.
speak.expected
Expected number of seconds utilized by the end of this month.
speak.bucket
Boolean value indicating whether the users current subscription has a bucket.
speak.limit
Number of seconds included in the user’s bucket, if present. Returns false if the bucket is unlimited (i.e. flatrate.)
data.usage
Number of bytes utilized for this period to date.
data.expected
Expected number of bytes utilized by the end of this month.
data.bucket
Boolean value indicating whether the users current subscription has a bucket.
data.limit
Number of bytes included in the user’s bucket.

Example

Request

GET /employee/consumption

Response

Status: 200 OK
{
  "period": {
    "begin_at": "2012-02-23T13:59:43+01:00",
    "end_at": "2012-02-30T22:00:00+01:00"
  },
  "speak": {
    "bucket": true,
    "usage": 6890,
    "expected": 12800,
    "limit": 10000
  },
  "data": {
    "bucket": true,
    "usage": 1065,
    "expected": 1405,
    "limit": 2500
  }
}