Retrieve device-level usage by contract

This endpoint provides detailed device-level usage data for specific contracts and invoices within a given timeframe.


📘

This endpoint is for use by Direct customers only

The detailed usage data is structured as a nested format, providing comprehensive records for all end customers (clients).

Each client record includes:

A list of devices with detailed information. Aggregated total usage by service for each customer, including metrics such as the amount of usage, price, and associated product features.


Sample response

{
    "AccountName": "Best MSP",
    "BpAccountId": 12348,
    "Cid": "234578",
    "ContractId": 234578,
    "ContractNumber": "MSP-234578-01",
    "ContractStatus": "ACTIVE",
    "Created": "2021-01-04 20:02:13.470",
    "PgaCode": "0100",
    "Pid": "0118M-0000-0000-UK",
    "ProductName": "Cove Data Protection | Data Protection Plan | MSP",
    "RateClassId": "234567",
    "SfdcAccountId": "001H234578asdfIAS",
    "TenantId": "0100_678905",
    "TimeFrame": 202405,
    "Updated": "2023-12-31 22:09:37.204",
    "TotalByContracts": [
        {
            "AccountName": "Best MSP",
            "BpAccountId": "345678",
            "Cid": "234578",
            "ContractId": "234567",
            "ContractNumber": "MSP-234578-01",
            "InvoiceId": "123467",
            "SfdcAccountId": "001H234578asdfIAS"
        }
    ],
    "Clients": []
}

Language
Credentials
Header
Click Try It! to start a request and see the response here!