Retrieve client-level only usage by timeframe

This endpoint provides detailed device-level usage data for all available products for a specified timeframe.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

❗️

Current month data can only be pulled from the 10th of the month onward.

📘

This endpoint is for use by Indirect and direct customers

The usage data is structured as a nested format, providing records of client level data per contract.

Sample response

{
    "UsageSummary": [
        {
            "AccountName": "Best MSP",
            "AdditionalCapacity": {...},
            "BpAccountId": 12348,
            "Cid": "234578",
            "Clients": [
                {
                    "ClientId": 2712428,
                    "Name": Best MSP,
                    "TotalByService": [
                        {
                            "BillingServiceName": "N-able Take Control | Concurrent User",
                            "ProductFeatureName": "0900_CONCURRENT_USER",
                            "Quantity": "1",
                            "Sku": "MSPUK-TC-TAKE_CONTROL",
                            "Uom": "Users"
                        }
                    ]
                }
            ],
            "ContractId": 234579,
            "ContractNumber": "MSP-234578-01",
            "ContractStatus": "ACTIVE",
            "Created": "2024-08-08 15:10:58.228",
            "PgaCode": "0900",
            "Pid": "0925M-0000-0000-UK",
            "ProductName": "N-able Take Control Plus | MSP | Monthly in Arrears",
            "RateClassId": "22142",
            "SfdcAccountId": "001H234578asdfIAS",
            "TenantId": "0900_0123",
            "TimeFrame": 202604,
            "Updated": "2025-09-02 00:15:15.951"
        }
    ]
}

Path Params
string
required

The billing period in YYYYMM format.

string
required

Salesforce account ID for the requesting MSP.

Headers
string

API key retrieved from developer portal. Required for authorisation.

string
required

Identifies the client application making the request. When scripting or calling this API programmatically, specify a custom User-Agent, as default User-Agents (e.g. those set automatically by HTTP libraries or tools like curl) may be blocked for security purposes.

integer
required

The size of the request body, in bytes.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*