POST /service/api/securecloud/usage/charges
 ?limit={limit}
 &offset={offset}
 &cursor={cursor}

Gets a list of subscription charges. A subscription charge provides a snapshot of a customer's current charges.

Note: The response from the charges API varies based on the filters, sorting parameters and fields specified in the request body. For more information, refer to the sections on Filter Operations and Expressions used for filtering results.

When using a cursor, body content is not allowed. In such a case, please construct the URI parameters as follows: 'page[limit]={yourlimit}&page[offset]={youroffset}&filter[chargeCode]={yourchargecode}&filter[isTrial]={true or false}&sort={sort field, e.g. ChargeCode}&sort={secondary sort field, e.g. -Currency}'. Following this, the resulting parameter string needs to be encoded (Base64) and then passed to the cursor as a URI parameter.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
limit

The maximum number of records to return.

integer

None.

offset

Specifies the number of records to skip, determining the starting point for displaying results.

integer

None.

cursor

Encoded value of the url. e.g. ZmlsdGVyW2lzQXV0b1JlbmV3XT1lcTondHJ1ZScmc29ydD1DaGFyZ2VDb2RlLC1DdXJyZW5jeSZwYWdlW2xpbWl0XT0xMCZwYWdlW29mZnNldF09MTA

string

None.

URI Sample(s)

POST
https://unityapi.webrootcloudav.com/service/api/securecloud/usage/charges?limit=15&offset=0
POST
https://unityapi.webrootcloudav.com/service/api/securecloud/usage/charges?limit=10
POST
https://unityapi.webrootcloudav.com/service/api/securecloud/usage/charges?cursor=c29ydD1DaGFyZ2VDb2RlLC1DdXJyZW5jeSZwYWdlW2xpbWl0XT0xJnBhZ2Vbb2Zmc2V0XT0x

Body Parameters

Additional information containing filters, sort order and a definition of fields that will be included in the response.

SubscriptionChargesRequestModel
NameDescriptionTypeAdditional Information
SubscriptionChargesFilterFields

Defines the charges filter fields. Each parameter is defined by operator:value pairs. For example the condition IsTrial equal to true is represented by "IsTrail": "eq:true".

SubscriptionChargesFilterFields

Optional

Sorting

Controls the sort order of the charges in the response. Multiple parameters can be specified, for example, {"IsTrial": "Ascending"}.

ChargesSorting

Optional

Fields

Defines the fields to be included in the response. (Optional, multiple parameters can be added).The parameter is case-insensitive. For example: "IsTrial", "chargeCode" . If it is omitted, the response will include all possible fields by default.

ChargesFields

Optional

Sample Request

{
  "SubscriptionChargesFilterFields": {
    "Id": "38416-BACKUP-1-1-BASICUSRS-59",
    "ChargeCode": "in:BASICUSRS-59,CRSUSRS-3",
    "ChargeName": "Cloud Charge 1",
    "ChargeType": "Recurring",
    "ProductName": "Cloud Product1",
    "ProductType": "CloudBackup",
    "BillableItem": "BasicUsers",
    "Price": "10",
    "TermPrice": "10",
    "Currency": "USD",
    "Quantity": "0",
    "Total": "0",
    "Description": "Cloud Charge 1",
    "SubscriptionStartDate": "2025-04-19T01:21:37.383Z",
    "SubscriptionCanceled": "false",
    "SubscriptionCanceledDate": "2025-04-19T01:21:37.383Z",
    "InitialTerm": "1",
    "CurrentTerm": "1",
    "CommitmentTerm": "0",
    "TermStartDate": "2025-04-19T01:21:37.383Z",
    "TermEndDate": "2025-07-19T01:21:37.383Z",
    "IsTrial": "eq:true",
    "IsAutoRenew": "eq:false",
    "EffectiveDate": "2025-05-04T01:21:37.383Z",
    "EndDate": null,
    "CustomerName": "[TEST] KPR AppRiver Resold",
    "CustomerType": "Resold",
    "ProductId": "8d9ebdee-cfc5-4515-b139-ad170101bd25",
    "PartnerId": "7b24e2ee-7018-40bd-8aab-a8eb00d7ed8b",
    "SubscriptionId": "38416-BACKUP-1-1",
    "CustomerId": "d53f91e8-ecb8-4d3b-aec8-ac3601501e0c",
    "BillToAccountId": "1195c23d-0fe0-435a-ad45-a8eb00d7ed0c"
  },
  "Sorting": {
    "Parameters": {
      "ChargeCode": "Ascending",
      "ChargeName": "Descending",
      "ChargeType": "Ascending",
      "ProductName": "Descending",
      "ProductType": "Ascending",
      "BillableItem": "Descending",
      "Price": "Ascending",
      "TermPrice": "Descending",
      "Currency": "Ascending",
      "Quantity": "Descending",
      "Total": "Ascending",
      "Description": "Descending",
      "SubscriptionStartDate": "Ascending",
      "SubscriptionCanceled": "Descending",
      "SubscriptionCanceledDate": "Ascending",
      "InitialTerm": "Descending",
      "CurrentTerm": "Ascending",
      "CommitmentTerm": "Descending",
      "TermStartDate": "Ascending",
      "TermEndDate": "Descending",
      "IsTrial": "Ascending",
      "IsAutoRenew": "Descending",
      "EffectiveDate": "Ascending",
      "EndDate": "Descending",
      "CustomerName": "Ascending",
      "CustomerType": "Descending"
    }
  },
  "Fields": {
    "FieldParam": [
      "ChargeCode",
      "CustomerName",
      "CustomerType",
      "ChargeName",
      "IsTrial",
      "IsAutoRenew",
      "EffectiveDate",
      "EndDate",
      "ChargeType",
      "ProductName",
      "ProductType",
      "BillableItem",
      "Price",
      "TermPrice",
      "Currency",
      "Quantity",
      "Total",
      "Description",
      "SubscriptionStartDate",
      "SubscriptionCanceled",
      "SubscriptionCanceledDate",
      "InitialTerm",
      "CurrentTerm",
      "CommitmentTerm",
      "TermStartDate",
      "TermEndDate"
    ]
  }
}                    
<SubscriptionChargesRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <Fields>
    <FieldParam xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>ChargeCode</d3p1:string>
      <d3p1:string>CustomerName</d3p1:string>
      <d3p1:string>CustomerType</d3p1:string>
      <d3p1:string>ChargeName</d3p1:string>
      <d3p1:string>IsTrial</d3p1:string>
      <d3p1:string>IsAutoRenew</d3p1:string>
      <d3p1:string>EffectiveDate</d3p1:string>
      <d3p1:string>EndDate</d3p1:string>
      <d3p1:string>ChargeType</d3p1:string>
      <d3p1:string>ProductName</d3p1:string>
      <d3p1:string>ProductType</d3p1:string>
      <d3p1:string>BillableItem</d3p1:string>
      <d3p1:string>Price</d3p1:string>
      <d3p1:string>TermPrice</d3p1:string>
      <d3p1:string>Currency</d3p1:string>
      <d3p1:string>Quantity</d3p1:string>
      <d3p1:string>Total</d3p1:string>
      <d3p1:string>Description</d3p1:string>
      <d3p1:string>SubscriptionStartDate</d3p1:string>
      <d3p1:string>SubscriptionCanceled</d3p1:string>
      <d3p1:string>SubscriptionCanceledDate</d3p1:string>
      <d3p1:string>InitialTerm</d3p1:string>
      <d3p1:string>CurrentTerm</d3p1:string>
      <d3p1:string>CommitmentTerm</d3p1:string>
      <d3p1:string>TermStartDate</d3p1:string>
      <d3p1:string>TermEndDate</d3p1:string>
    </FieldParam>
  </Fields>
  <Sorting>
    <Parameters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>ChargeCode</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>ChargeName</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>ChargeType</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>ProductName</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>ProductType</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>BillableItem</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>Price</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>TermPrice</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>Currency</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>Quantity</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>Total</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>Description</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>SubscriptionStartDate</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>SubscriptionCanceled</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>SubscriptionCanceledDate</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>InitialTerm</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>CurrentTerm</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>CommitmentTerm</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>TermStartDate</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>TermEndDate</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>IsTrial</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>IsAutoRenew</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>EffectiveDate</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>EndDate</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>CustomerName</d3p1:Key>
        <d3p1:Value>Ascending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>CustomerType</d3p1:Key>
        <d3p1:Value>Descending</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Parameters>
  </Sorting>
  <SubscriptionChargesFilterFields>
    <BillToAccountId>1195c23d-0fe0-435a-ad45-a8eb00d7ed0c</BillToAccountId>
    <BillableItem>BasicUsers</BillableItem>
    <ChargeCode>in:BASICUSRS-59,CRSUSRS-3</ChargeCode>
    <ChargeName>Cloud Charge 1</ChargeName>
    <ChargeType>Recurring</ChargeType>
    <CommitmentTerm>0</CommitmentTerm>
    <Currency>USD</Currency>
    <CurrentTerm>1</CurrentTerm>
    <CustomerId>d53f91e8-ecb8-4d3b-aec8-ac3601501e0c</CustomerId>
    <CustomerName>[TEST] KPR AppRiver Resold</CustomerName>
    <CustomerType>Resold</CustomerType>
    <Description>Cloud Charge 1</Description>
    <EffectiveDate>2025-05-04T01:21:37.383Z</EffectiveDate>
    <EndDate i:nil="true" />
    <Id>38416-BACKUP-1-1-BASICUSRS-59</Id>
    <InitialTerm>1</InitialTerm>
    <IsAutoRenew>eq:false</IsAutoRenew>
    <IsTrial>eq:true</IsTrial>
    <PartnerId>7b24e2ee-7018-40bd-8aab-a8eb00d7ed8b</PartnerId>
    <Price>10</Price>
    <ProductId>8d9ebdee-cfc5-4515-b139-ad170101bd25</ProductId>
    <ProductName>Cloud Product1</ProductName>
    <ProductType>CloudBackup</ProductType>
    <Quantity>0</Quantity>
    <SubscriptionCanceled>false</SubscriptionCanceled>
    <SubscriptionCanceledDate>2025-04-19T01:21:37.383Z</SubscriptionCanceledDate>
    <SubscriptionId>38416-BACKUP-1-1</SubscriptionId>
    <SubscriptionStartDate>2025-04-19T01:21:37.383Z</SubscriptionStartDate>
    <TermEndDate>2025-07-19T01:21:37.383Z</TermEndDate>
    <TermPrice>10</TermPrice>
    <TermStartDate>2025-04-19T01:21:37.383Z</TermStartDate>
    <Total>0</Total>
  </SubscriptionChargesFilterFields>
</SubscriptionChargesRequestModel>                    

Response Information

Resource Description

Returns object of subscriptionChargesResponseModel which is the list of subscription charges. A subscription charge is a snapshot of a customer's current charges.

SubscriptionChargesResponseModel
NameDescriptionTypeAdditional Information
Data

Provides information associated with the subscription charge.

Collection of SubscriptionChargesResult

None.

Links

Page details.

SubscriptionChargesLinks

None.

Meta

Total number of records associated with the subscription charge result.

SubscriptionChargesPageMeta

None.

Sample Response

{
  "Data": [
    {
      "Type": "subscriptionCharges",
      "Id": "38416-BACKUP-1-1-BASICUSRS-59",
      "Attributes": {
        "ChargeCode": "in:BASICUSRS-59,CRSUSRS-3",
        "ChargeName": "Cloud Charge 1",
        "ChargeType": "Recurring",
        "ProductName": "Cloud Product1",
        "ProductType": "CloudBackup",
        "BillableItem": "BasicUsers",
        "Price": 10.0,
        "TermPrice": 10.0,
        "Currency": "USD",
        "Quantity": 0,
        "Total": 0.0,
        "Description": "Cloud Charge 1",
        "SubscriptionStartDate": "2025-04-19T01:21:37.6465551Z",
        "SubscriptionCanceled": false,
        "SubscriptionCanceledDate": "2025-04-19T01:21:37.6465551Z",
        "InitialTerm": 1,
        "CurrentTerm": 1,
        "CommitmentTerm": 0,
        "TermStartDate": "2025-04-19T01:21:37.6465551Z",
        "TermEndDate": "2025-07-19T01:21:37.6465551Z",
        "IsTrial": true,
        "IsAutoRenew": false,
        "EffectiveDate": "2025-05-04T01:21:37.6465551Z",
        "EndDate": null,
        "CustomerName": "[TEST] KPR AppRiver Resold",
        "CustomerType": "Resold"
      },
      "Relationships": {
        "Product": {
          "Data": {
            "Type": "products",
            "Id": "8d9ebdee-cfc5-4515-b139-ad170101bd25",
            "Meta": {}
          }
        },
        "Partner": {
          "Data": {
            "Type": "partners",
            "Id": "7b24e2ee-7018-40bd-8aab-a8eb00d7ed8b",
            "Meta": {}
          }
        },
        "Subscription": {
          "Data": {
            "Type": "subscriptions",
            "Id": "38416-BACKUP-1-1",
            "Meta": {}
          }
        },
        "Customer": {
          "Data": {
            "Type": "",
            "Id": "d53f91e8-ecb8-4d3b-aec8-ac3601501e0c",
            "Meta": {}
          }
        },
        "BillToAccount": {
          "Data": {
            "Type": "billingAccounts",
            "Id": "1195c23d-0fe0-435a-ad45-a8eb00d7ed0c",
            "Meta": {}
          }
        }
      }
    }
  ],
  "Links": {
    "NextPageLimit": 10,
    "NextPageOffset": 10
  },
  "Meta": {
    "Page": {
      "Total": 10
    }
  }
}                    
<SubscriptionChargesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <Data>
    <SubscriptionChargesResult>
      <Attributes>
        <BillableItem>BasicUsers</BillableItem>
        <ChargeCode>in:BASICUSRS-59,CRSUSRS-3</ChargeCode>
        <ChargeName>Cloud Charge 1</ChargeName>
        <ChargeType>Recurring</ChargeType>
        <CommitmentTerm>0</CommitmentTerm>
        <Currency>USD</Currency>
        <CurrentTerm>1</CurrentTerm>
        <CustomerName>[TEST] KPR AppRiver Resold</CustomerName>
        <CustomerType>Resold</CustomerType>
        <Description>Cloud Charge 1</Description>
        <EffectiveDate>2025-05-04T01:21:37.6465551Z</EffectiveDate>
        <EndDate i:nil="true" />
        <InitialTerm>1</InitialTerm>
        <IsAutoRenew>false</IsAutoRenew>
        <IsTrial>true</IsTrial>
        <Price>10</Price>
        <ProductName>Cloud Product1</ProductName>
        <ProductType>CloudBackup</ProductType>
        <Quantity>0</Quantity>
        <SubscriptionCanceled>false</SubscriptionCanceled>
        <SubscriptionCanceledDate>2025-04-19T01:21:37.6465551Z</SubscriptionCanceledDate>
        <SubscriptionStartDate>2025-04-19T01:21:37.6465551Z</SubscriptionStartDate>
        <TermEndDate>2025-07-19T01:21:37.6465551Z</TermEndDate>
        <TermPrice>10</TermPrice>
        <TermStartDate>2025-04-19T01:21:37.6465551Z</TermStartDate>
        <Total>0</Total>
      </Attributes>
      <Id>38416-BACKUP-1-1-BASICUSRS-59</Id>
      <Relationships>
        <BillToAccount>
          <Data>
            <Id>1195c23d-0fe0-435a-ad45-a8eb00d7ed0c</Id>
            <Meta>
              <BillToAccountNumber i:nil="true" />
              <CustomerNumber i:nil="true" />
            </Meta>
            <Type>billingAccounts</Type>
          </Data>
        </BillToAccount>
        <Customer>
          <Data>
            <Id>d53f91e8-ecb8-4d3b-aec8-ac3601501e0c</Id>
            <Meta>
              <BillToAccountNumber i:nil="true" />
              <CustomerNumber i:nil="true" />
            </Meta>
            <Type></Type>
          </Data>
        </Customer>
        <Partner>
          <Data>
            <Id>7b24e2ee-7018-40bd-8aab-a8eb00d7ed8b</Id>
            <Meta>
              <BillToAccountNumber i:nil="true" />
              <CustomerNumber i:nil="true" />
            </Meta>
            <Type>partners</Type>
          </Data>
        </Partner>
        <Product>
          <Data>
            <Id>8d9ebdee-cfc5-4515-b139-ad170101bd25</Id>
            <Meta>
              <BillToAccountNumber i:nil="true" />
              <CustomerNumber i:nil="true" />
            </Meta>
            <Type>products</Type>
          </Data>
        </Product>
        <Subscription>
          <Data>
            <Id>38416-BACKUP-1-1</Id>
            <Meta>
              <BillToAccountNumber i:nil="true" />
              <CustomerNumber i:nil="true" />
            </Meta>
            <Type>subscriptions</Type>
          </Data>
        </Subscription>
      </Relationships>
      <Type>subscriptionCharges</Type>
    </SubscriptionChargesResult>
  </Data>
  <Links>
    <NextPageLimit>10</NextPageLimit>
    <NextPageOffset>10</NextPageOffset>
  </Links>
  <Meta>
    <Page>
      <Total>10</Total>
    </Page>
  </Meta>
</SubscriptionChargesResponseModel>