Products: Managed Backup (Agent)
Article ID: m0656Last Modified: 29-Sep-2024

PUT API/Billing

Request Information

URI Parameters

None.

Body Parameters

Name Description Type Additional Information
CompanyName If empty or skipped, results for all companies will be returned string None
Date Empty Value will Return the Current Month. In case if empty or skipped, the current month will be returned date None

Request Formats

application/json, text/json

{
  "CompanyName": "sample string 1",
  "Date": "2019-08-29T16:22:28.3453625+00:00"
}

application/xml, text/xml

<FilterTotalModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <CompanyName>sample string 1</CompanyName>
  <Date>2019-08-29T16:22:28.3453625+00:00</Date>
</FilterTotalModels>

Response Information

Resource Description

BillingModels

Name Description Type Additional Information
CurrentSpaceUsed Amount of Space Used by All Users at the Moment or Report. This Value is Updated Once a Day integer None
AverageSpaceUsed An Average Amount of a Space Used by All Users for Specified Month. Is Calculated basing on Backup Plans Information integer None
TotalRestore Total Value of Restores integer None
StatisticBilling - Collection of StatisticBillingModels None

Response Formats

application/json, text/json

{
  "CurrentSpaceUsed": 1,
  "AverageSpaceUsed": 2,
  "TotalRestore": 3,
  "StatisticBilling": [
    {
      "UserId": "623cee71-6aef-4bb1-890a-016e16779fad",
      "Email": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "CompanyName": "sample string 5",
      "AverageSpace": 6,
      "TotalVolumeRestore": 7,
      "PlanCost": 8.0,
      "StorageCost": 9.0,
      "RestoreCost": 10.0,
      "TotalCost": 11.0
    },
    {
      "UserId": "623cee71-6aef-4bb1-890a-016e16779fad",
      "Email": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "CompanyName": "sample string 5",
      "AverageSpace": 6,
      "TotalVolumeRestore": 7,
      "PlanCost": 8.0,
      "StorageCost": 9.0,
      "RestoreCost": 10.0,
      "TotalCost": 11.0
    }
  ]
}

application/xml, text/xml

<BillingModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <AverageSpaceUsed>2</AverageSpaceUsed>
  <CurrentSpaceUsed>1</CurrentSpaceUsed>
  <StatisticBilling>
    <StatisticBillingModels>
      <AverageSpace>6</AverageSpace>
      <CompanyName>sample string 5</CompanyName>
      <Email>sample string 2</Email>
      <FirstName>sample string 3</FirstName>
      <LastName>sample string 4</LastName>
      <PlanCost>8</PlanCost>
      <RestoreCost>10</RestoreCost>
      <StorageCost>9</StorageCost>
      <TotalCost>11</TotalCost>
      <TotalVolumeRestore>7</TotalVolumeRestore>
      <UserId>623cee71-6aef-4bb1-890a-016e16779fad</UserId>
    </StatisticBillingModels>
    <StatisticBillingModels>
      <AverageSpace>6</AverageSpace>
      <CompanyName>sample string 5</CompanyName>
      <Email>sample string 2</Email>
      <FirstName>sample string 3</FirstName>
      <LastName>sample string 4</LastName>
      <PlanCost>8</PlanCost>
      <RestoreCost>10</RestoreCost>
      <StorageCost>9</StorageCost>
      <TotalCost>11</TotalCost>
      <TotalVolumeRestore>7</TotalVolumeRestore>
      <UserId>623cee71-6aef-4bb1-890a-016e16779fad</UserId>
    </StatisticBillingModels>
  </StatisticBilling>
  <TotalRestore>3</TotalRestore>
</BillingModels>
https://git.cloudberrylab.com/egor.m/doc-help-mbs.git