POST /service/api/securecloud/usage/charges/events
?limit={limit}
&offset={offset}
&cursor={cursor}
Gets a list of subscription charge events. A subscription charge event is triggered when a customer subscription is created, renewed, or when the usage or license count for a subscription is adjusted.
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
Name | Description | Type | Additional Information |
---|---|---|---|
limit |
The maximum number of records to return. |
integer |
None. |
offset |
The number of records to be skipped (the first record to be displayed). |
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/events?limit = 15&offset=0
|
POST
|
https://unityapi.webrootcloudav.com/service/api/securecloud/usage/charges/events?limit=10
|
POST
|
https://unityapi.webrootcloudav.com/service/api/securecloud/usage/charges/events?cursor=c29ydD1DaGFyZ2VDb2RlJnBhZ2VbbGltaXRdPTEmcGFnZVtvZmZzZXRdPTE=
|
Body Parameters
Additional information containing filters, sort order and a definition of fields that will be included in the response.
SubscriptionChargesEventsRequestModelName | Description | Type | Additional Information |
---|---|---|---|
SubscriptionChargesEventFilterFields |
Filters the charges events (optional, multiple parameters can be added) e.g. "IsTrial": "eq:false". |
SubscriptionChargesEventsFilterFields |
Optional. |
Sorting |
Controls sort order of the events in the response (optional, multiple parameters can be added) e.g. {"IsTrial","Ascending"}. |
EventSorting |
Optional. |
Fields |
Defines the fields to be included in the response. (optional, multiple parameters can be added).The parameter is case-insensitive(e.g. ["IsTrial", "chargeCode"]). If it is omitted, the response will include all possible fields by default. |
EventFields |
Optional. |
Sample Request
{ "SubscriptionChargesEventFilterFields": { "Id": "38416-BACKUP-1-1-BASICUSRS-59", "ChargeCode": "in:BASICUSRS-59,CRSUSRS-3", "ChargeName": "Cloud Charge 1", "ChargeType": "Recurring", "ProductName": "Cloud Product1", "ProductType": "eq:CloudBackup", "IsOffice365Nce": "true", "BillableItem": "BasicUsers", "Price": "10", "TermPrice": "10", "Currency": "USD", "Quantity": "0", "PreviousQuantity": "0", "Total": "0", "EventType": "ne:Renewal", "Description": "Cloud Charge 1", "SubscriptionStartDate": "2024-12-21T18:23:21.548Z", "SubscriptionCanceled": "false", "SubscriptionCanceledDate": "2024-12-21T18:23:21.548Z", "InitialTerm": "1", "CurrentTerm": "1", "CommitmentTerm": "0", "TermStartDate": "2024-12-21T18:23:21.548Z", "TermEndDate": "2025-03-21T18:23:21.548Z", "IsTrial": "eq:true", "IsAutoRenew": "eq:false", "EffectiveDate": "2025-01-05T18:23:21.548Z", "EndDate": "2024-12-21T18:23:21.548Z", "SubscriptionProductUpdated": "false", "SubscriptionProductUpdatedDate": "2024-12-21T18:23:21.548Z", "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", "IsOffice365Nce": "Descending", "BillableItem": "Ascending", "Price": "Descending", "TermPrice": "Ascending", "Currency": "Descending", "Quantity": "Ascending", "PreviousQuantity": "Descending", "Total": "Ascending", "EventType": "Descending", "Description": "Ascending", "SubscriptionStartDate": "Descending", "SubscriptionCanceled": "Ascending", "SubscriptionCanceledDate": "Descending", "InitialTerm": "Ascending", "CurrentTerm": "Descending", "CommitmentTerm": "Ascending", "TermStartDate": "Descending", "TermEndDate": "Ascending", "IsTrial": "Descending", "IsAutoRenew": "Ascending", "EffectiveDate": "Descending", "EndDate": "Ascending", "SubscriptionProductUpdated": "Descending", "SubscriptionProductUpdatedDate": "Ascending", "CustomerName": "Descending", "CustomerType": "Ascending" } }, "Fields": { "FieldParam": [ "ChargeCode", "ChargeName", "ChargeType", "ProductName", "ProductType", "IsOffice365Nce", "BillableItem", "Price", "TermPrice", "Currency", "Quantity", "PreviousQuantity", "Total", "EventType", "Description", "SubscriptionStartDate", "SubscriptionCanceled", "SubscriptionCanceledDate", "InitialTerm", "CurrentTerm", "CommitmentTerm", "TermStartDate", "TermEndDate", "IsTrial", "IsAutoRenew", "EffectiveDate", "EndDate", "SubscriptionProductUpdated", "SubscriptionProductUpdatedDate", "CustomerName", "CustomerType" ] } }
<SubscriptionChargesEventsRequestModel 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>ChargeName</d3p1:string> <d3p1:string>ChargeType</d3p1:string> <d3p1:string>ProductName</d3p1:string> <d3p1:string>ProductType</d3p1:string> <d3p1:string>IsOffice365Nce</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>PreviousQuantity</d3p1:string> <d3p1:string>Total</d3p1:string> <d3p1:string>EventType</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> <d3p1:string>IsTrial</d3p1:string> <d3p1:string>IsAutoRenew</d3p1:string> <d3p1:string>EffectiveDate</d3p1:string> <d3p1:string>EndDate</d3p1:string> <d3p1:string>SubscriptionProductUpdated</d3p1:string> <d3p1:string>SubscriptionProductUpdatedDate</d3p1:string> <d3p1:string>CustomerName</d3p1:string> <d3p1:string>CustomerType</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>IsOffice365Nce</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>BillableItem</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>Price</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>TermPrice</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>Currency</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>Quantity</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>PreviousQuantity</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>EventType</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>Description</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>SubscriptionStartDate</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>SubscriptionCanceled</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>SubscriptionCanceledDate</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>InitialTerm</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>CurrentTerm</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>CommitmentTerm</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>TermStartDate</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>TermEndDate</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>IsTrial</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>IsAutoRenew</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>EffectiveDate</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>EndDate</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>SubscriptionProductUpdated</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>SubscriptionProductUpdatedDate</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>CustomerName</d3p1:Key> <d3p1:Value>Descending</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>CustomerType</d3p1:Key> <d3p1:Value>Ascending</d3p1:Value> </d3p1:KeyValueOfstringstring> </Parameters> </Sorting> <SubscriptionChargesEventFilterFields> <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-01-05T18:23:21.548Z</EffectiveDate> <EndDate>2024-12-21T18:23:21.548Z</EndDate> <EventType>ne:Renewal</EventType> <Id>38416-BACKUP-1-1-BASICUSRS-59</Id> <InitialTerm>1</InitialTerm> <IsAutoRenew>eq:false</IsAutoRenew> <IsOffice365Nce>true</IsOffice365Nce> <IsTrial>eq:true</IsTrial> <PartnerId>7b24e2ee-7018-40bd-8aab-a8eb00d7ed8b</PartnerId> <PreviousQuantity>0</PreviousQuantity> <Price>10</Price> <ProductId>8d9ebdee-cfc5-4515-b139-ad170101bd25</ProductId> <ProductName>Cloud Product1</ProductName> <ProductType>eq:CloudBackup</ProductType> <Quantity>0</Quantity> <SubscriptionCanceled>false</SubscriptionCanceled> <SubscriptionCanceledDate>2024-12-21T18:23:21.548Z</SubscriptionCanceledDate> <SubscriptionId>38416-BACKUP-1-1</SubscriptionId> <SubscriptionProductUpdated>false</SubscriptionProductUpdated> <SubscriptionProductUpdatedDate>2024-12-21T18:23:21.548Z</SubscriptionProductUpdatedDate> <SubscriptionStartDate>2024-12-21T18:23:21.548Z</SubscriptionStartDate> <TermEndDate>2025-03-21T18:23:21.548Z</TermEndDate> <TermPrice>10</TermPrice> <TermStartDate>2024-12-21T18:23:21.548Z</TermStartDate> <Total>0</Total> </SubscriptionChargesEventFilterFields> </SubscriptionChargesEventsRequestModel>
Response Information
Resource Description
Returns object of subscriptionChargeEventsResponseModel which is list of subscription charge events. A subscription charge event occurs when a customer subscription is created or renewed, or the usage or license count is adjusted for a subscription.
SubscriptionChargesEventsResponseModelName | Description | Type | Additional Information |
---|---|---|---|
Data |
Subscription charge's information events associated with the subscription charge. |
Collection of SubscriptionChargesEventResult |
None. |
Links |
Page details. |
SubscriptionChargesEventLinks |
None. |
Meta |
Total number of records associated with the subscription charge event result. |
SubscriptionChargesEventPageMeta |
None. |
Sample Response
{ "Data": [ { "Type": "subscriptionChargeEvents", "Id": "38416-BACKUP-1-1-BASICUSRS-59", "Attributes": { "ChargeCode": "in:BASICUSRS-59,CRSUSRS-3", "ChargeName": "Cloud Charge 1", "ChargeType": "Recurring", "ProductName": "Cloud Product1", "ProductType": "eq:CloudBackup", "IsOffice365Nce": true, "BillableItem": "BasicUsers", "Price": 10.0, "TermPrice": 10.0, "Currency": "USD", "Quantity": 0.0, "PreviousQuantity": 0.0, "Total": 0.0, "EventType": "ne:Renewal", "Description": "Cloud Charge 1", "SubscriptionStartDate": "2024-12-21T18:23:21.5644202Z", "SubscriptionCanceled": false, "SubscriptionCanceledDate": "2024-12-21T18:23:21.5644202Z", "InitialTerm": 1, "CurrentTerm": 1, "CommitmentTerm": 0, "TermStartDate": "2024-12-21T18:23:21.5644202Z", "TermEndDate": "2025-03-21T18:23:21.5644202Z", "IsTrial": true, "IsAutoRenew": false, "EffectiveDate": "2025-01-05T18:23:21.5644202Z", "EndDate": null, "SubscriptionProductUpdated": false, "SubscriptionProductUpdatedDate": 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": "customers", "Id": "d53f91e8-ecb8-4d3b-aec8-ac3601501e0c", "Meta": { "CustomerNumber": "45382" } } }, "BillToAccount": { "Data": { "Type": "billingAccounts", "Id": "1195c23d-0fe0-435a-ad45-a8eb00d7ed0c", "Meta": { "BillToAccountNumber": "C10002-1" } } } } } ], "Links": { "NextPageLimit": 10, "NextPageOffset": 10 }, "Meta": { "Page": { "Total": 10 } } }
<SubscriptionChargesEventsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models"> <Data> <SubscriptionChargesEventResult> <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-01-05T18:23:21.5644202Z</EffectiveDate> <EndDate i:nil="true" /> <EventType>ne:Renewal</EventType> <InitialTerm>1</InitialTerm> <IsAutoRenew>false</IsAutoRenew> <IsOffice365Nce>true</IsOffice365Nce> <IsTrial>true</IsTrial> <PreviousQuantity>0</PreviousQuantity> <Price>10</Price> <ProductName>Cloud Product1</ProductName> <ProductType>eq:CloudBackup</ProductType> <Quantity>0</Quantity> <SubscriptionCanceled>false</SubscriptionCanceled> <SubscriptionCanceledDate>2024-12-21T18:23:21.5644202Z</SubscriptionCanceledDate> <SubscriptionProductUpdated>false</SubscriptionProductUpdated> <SubscriptionProductUpdatedDate i:nil="true" /> <SubscriptionStartDate>2024-12-21T18:23:21.5644202Z</SubscriptionStartDate> <TermEndDate>2025-03-21T18:23:21.5644202Z</TermEndDate> <TermPrice>10</TermPrice> <TermStartDate>2024-12-21T18:23:21.5644202Z</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>C10002-1</BillToAccountNumber> <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>45382</CustomerNumber> </Meta> <Type>customers</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>subscriptionChargeEvents</Type> </SubscriptionChargesEventResult> </Data> <Links> <NextPageLimit>10</NextPageLimit> <NextPageOffset>10</NextPageOffset> </Links> <Meta> <Page> <Total>10</Total> </Page> </Meta> </SubscriptionChargesEventsResponseModel>