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-234567-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": 202508,
    "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",
						"AdditionalCapacity": [
                {
                    "AdditionalCapacity": "-1830.479000000003",
                    "SelectedGbUsageQuantity": "2699.520999999997",
                    "Servers": {
                        "CommittedCount": 4,
                        "DeviceCount": 5,
                        "FUP": 2000,
                        "Pool": 10000,
                        "UsageCount": 5
                    },
                    "TimeFrame": 202508,
                    "TotalPool": 45500,
                    "UsedGB": "2699.520999999997",
                    "UsedGbUsageQuantity": "4452.173999999999",
                    "VirtualServers": {
                        "CommittedCount": 20,
                        "DeviceCount": 20,
                        "UsageCount": 15
                    },
                    "Workstations": {
                        "CommittedCount": 2,
                        "DeviceCount": 3,
                        "FUP": 500,
                        "Pool": 1500,
                        "UsageCount": 3
                    },
                    "Amount": "0",
                    "Price": "0.02",
                    "ProductFeatureName": "0100_ADDITIONAL_CAPACITY",
                    "Quantity": "0",
                    "Sku": "MSPUK-BU-AC"
                }
            ]
        }
    ],
      "Clients": [
					{
            "ClientId": "1223442",
            "Devices": [
                {
                    "Detail": "username",
                    "DetailId": "deviceid",
                    "UsageLevel_5": "companyname",
                    "UsageLevel_3": "distiriutorname",
                    "UsageCompanyName": "customercompany",
                    "TotalByService": [
                        {
                            "Amount": 0.000,
                            "BillingServiceName": "Cove Data Protection | Per GB - Selected",
                            "Price": 0.000,
                            "ProductFeatureName": "0100_SELECTED_SIZE",
                            "Quantity": 195.860,
                            "Sku": "MSPUK-BU-PGS",
                            "Uom": "GB"
                        }
                    ]
                }
            ],
						"Name": "customercompany",
            "TotalByService": [
                {
                    "Amount": 0.000,
                    "BillingServiceName": "Cove Data Protection | Per GB - Selected",
                    "Price": 0.000,
                    "ProductFeatureName": "0100_SELECTED_SIZE",
                    "Quantity": 195.860,
                    "Sku": "MSPUK-BU-PGS",
                    "Uom": "GB"
                }
              ]
          }
      ]
}

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