---
updatedAt: 2025-06-05T21:49:04.000Z
agentTools:
  projectIndex: https://docs.cloudloop.com/llms.txt
---

# Get Usage

Retrieve itemised usage for Subscriber in given month

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "cloudloop",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.cloudloop.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "query",
        "name": "token"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/Telephony/GetUsage": {
      "get": {
        "summary": "Get Usage",
        "description": "Retrieve itemised usage for Subscriber in given month",
        "operationId": "usage-1",
        "parameters": [
          {
            "name": "subscriber",
            "in": "query",
            "description": "CloudLoop Subscriber Id",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "year",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 2018
            }
          },
          {
            "name": "month",
            "in": "query",
            "description": "1-12",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"usage\": [\n    {\n      \"duration\": 41,\n      \"at\": \"2018-05-04T09:08:56\",\n      \"cost\": 4.100,\n      \"fee\": \"TELEPHONY_DATA_DIRECT_INTERNET_GO\",\n      \"contract\": \"wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk\"\n    },\n    {\n      \"duration\": 80,\n      \"at\": \"2018-05-04T09:08:57\",\n      \"cost\": 8.000,\n      \"fee\": \"TELEPHONY_VOICE_IRIDIUM_TO_PSTN\",\n      \"contract\": \"wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk\"\n    },\n    {\n      \"duration\": 58,\n      \"at\": \"2018-05-04T09:08:58\",\n      \"cost\": 5.800,\n      \"fee\": \"TELEPHONY_DATA_DIRECT_INTERNET_GO\",\n      \"contract\": \"wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk\"\n    },\n    {\n      \"duration\": 56,\n      \"at\": \"2018-05-04T09:08:59\",\n      \"cost\": 5.600,\n      \"fee\": \"TELEPHONY_VOICE_LOCAL_TO_IRIDIUM\",\n      \"contract\": \"wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk\"\n    },\n    {\n      \"duration\": 84,\n      \"at\": \"2018-05-04T09:09:00\",\n      \"cost\": 8.400,\n      \"fee\": \"TELEPHONY_DATA_DIRECT_INTERNET_GO\",\n      \"contract\": \"wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk\"\n    },\n    {\n      \"duration\": 56,\n      \"at\": \"2018-05-04T09:09:01\",\n      \"cost\": 5.600,\n      \"fee\": \"TELEPHONY_VOICE_IRIDIUM_TO_PSTN\",\n      \"contract\": \"wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk\"\n    },\n    {\n      \"duration\": 31,\n      \"at\": \"2018-05-04T09:09:02\",\n      \"cost\": 3.100,\n      \"fee\": \"TELEPHONY_DATA_DIRECT_INTERNET_GO\",\n      \"contract\": \"wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk\"\n    },\n    {\n      \"duration\": 33,\n      \"at\": \"2018-05-04T09:09:03\",\n      \"cost\": 3.300,\n      \"fee\": \"TELEPHONY_VOICE_LOCAL_TO_IRIDIUM\",\n      \"contract\": \"wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk\"\n    },\n    {\n      \"duration\": 86,\n      \"at\": \"2018-05-04T09:09:04\",\n      \"cost\": 8.600,\n      \"fee\": \"TELEPHONY_DATA_DIRECT_INTERNET_GO\",\n      \"contract\": \"wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk\"\n    },\n    {\n      \"duration\": 57,\n      \"at\": \"2018-05-04T09:09:05\",\n      \"cost\": 5.700,\n      \"fee\": \"TELEPHONY_VOICE_IRIDIUM_TO_PSTN\",\n      \"contract\": \"wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk\"\n    }\n  ]\n}"
                  },
                  "Incomplete Input": {
                    "value": "{\n  \"at\": 1525425009448,\n  \"error\": \"DispatcherInputException\"\n}\n"
                  },
                  "Service Unavailable": {
                    "value": "{\n  \"at\": 1527861082868,\n  \"error\": \"DispatcherUnavailableException\"\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "usage": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "duration": {
                                "type": "integer",
                                "example": 41,
                                "default": 0
                              },
                              "at": {
                                "type": "string",
                                "example": "2018-05-04T09:08:56"
                              },
                              "cost": {
                                "type": "number",
                                "example": 4.1,
                                "default": 0
                              },
                              "fee": {
                                "type": "string",
                                "example": "TELEPHONY_DATA_DIRECT_INTERNET_GO"
                              },
                              "contract": {
                                "type": "string",
                                "example": "wbpYqLdxyzVrAEYRjDBQmgRMjGOvoeZk"
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "title": "Incomplete Input",
                      "type": "object",
                      "properties": {
                        "at": {
                          "type": "integer",
                          "example": 1525425009448,
                          "default": 0
                        },
                        "error": {
                          "type": "string",
                          "example": "DispatcherInputException"
                        }
                      }
                    },
                    {
                      "title": "Service Unavailable",
                      "type": "object",
                      "properties": {
                        "at": {
                          "type": "integer",
                          "example": 1527861082868,
                          "default": 0
                        },
                        "error": {
                          "type": "string",
                          "example": "DispatcherUnavailableException"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```