GET /service/api/securecloud/customers/{customerId}/subscriptions/{subscriptionKey}

Provides information about a subscription.

Note: The subscription key can be provided either in Base64-encoded form or as an unencoded string, and should be passed as the subscriptionKey parameter in the URL path.

Request Information

URI Parameters

Name	Description	Type	Additional Information
customerId	Identifier used to query information about an end customer.	string	Required
subscriptionKey	A unique identifier, either encoded or non-encoded, used to identify a subscription.	string	Required

URI Sample(s)


GET	https://unityapi.webrootcloudav.com/service/api/securecloud/customers/1e0a7a3c-92b7-480d-a48f-a38600f660bf/subscriptions/MTI1OTQ3LUJBQ0tVUC0zMS10bGguZG9tYWluc3dhcC56aXh0ZXN0LnRlc3Q=
GET	https://unityapi.webrootcloudav.com/service/api/securecloud/customers/1e0a7a3c-92b7-480d-a48f-a38600f660bf/subscriptions/125947-BACKUP-31-tlh.domainswap.zixtest.test

Body Parameters

None.

Response Information

Resource Description

Subscription Details.

GetSubscriptionDetailResponseModel

Name	Description	Type	Additional Information
SubscriptionKey	Unique identifier of the subscription.	string	None.
ProductName	Name of the product.	string	None.
Categories	Categories associated with the product.	Collection of string	None.
Domain	Primary domain of the subscription. If the subscription does not require a domain, a domain value is not returned.	string	None.
Aliases	Domain aliases or additional domains for the subscription.	Collection of string	None.
IsTrial	Indicates whether the subscription is a trial. Valid values are: True , False.	boolean	None.
SubscriptionTerm	Term of the subscription. Valid values are: Monthly, Quarterly, Biannual, Annual, Triennial.	string	None.
BillingFrequency	Frequency of billing the customer for the subscription. Valid values are: Monthly, Quarterly, Biannual, Annual, Triennial.	string	None.
ExpirationBehavior	Action that occurs when the subscription expires. Valid values are: None, AutoRenew, AutoConvert.	string	None.
SubscriptionStatus	Status of the subscription. Valid values are: Active, Trial, Installing, Not Installed, Scheduled to Uninstall, Uninstalling, Cancelled, Suspending, Suspended.	string	None.
StartDate	Start date of the subscription.	date	None.
ExpirationDate	End date of the subscription.	date	None.
CancellationDate	Date when the subscription was cancelled.	date	None.
CancellationGracePeriod	Number of days after the cancellation date when the subscription will be uninstalled, if it is not renewed or cancelled.	integer	None.
ScheduledUninstallDate	Date when the subscription is scheduled to be uninstalled.	date	None.
AvailableActions	Available actions for the subscription.	AvailableSubscriptionActions	None.
ConfigurableSubscriptionDetails	Set of properties that can be changed for the subscription.	Collection of ConfigurableSubscriptionDetail	None.
ReadonlySubscriptionDetails	Set of properties that were configured for the subscription and cannot be changed.	Collection of ReadonlySubscriptionDetail	None.

Sample Response

{
  "SubscriptionKey": "192837-TESDF-1-spg.com",
  "ProductName": "Cloud Backup",
  "Categories": [
    "Recovery"
  ],
  "Domain": "spg.com",
  "Aliases": [
    "def.spc.com"
  ],
  "IsTrial": false,
  "SubscriptionTerm": "Monthly",
  "BillingFrequency": "Monthly",
  "ExpirationBehavior": "AutoRenew",
  "SubscriptionStatus": "Active",
  "StartDate": "2025-07-18T14:09:21.7227565Z",
  "ExpirationDate": "2025-09-16T14:09:21.7227565Z",
  "CancellationDate": "2025-07-23T14:09:21.7227565Z",
  "CancellationGracePeriod": 27,
  "ScheduledUninstallDate": "2025-09-17T14:09:21.7227565Z",
  "AvailableActions": {
    "CanCancel": true,
    "CanConfigure": true,
    "CanRestore": true,
    "CanSuspend": false,
    "CanUpgrade": false,
    "CanDowngrade": false
  },
  "ConfigurableSubscriptionDetails": [
    {
      "Name": "SubscriptionQuantity",
      "Value": "10"
    }
  ],
  "ReadonlySubscriptionDetails": [
    {
      "Name": "TotalLicenses",
      "Value": "15"
    },
    {
      "Name": "AssignedLicenses",
      "Value": "10"
    },
    {
      "Name": "UnassignedLicenses",
      "Value": "5"
    },
    {
      "Name": "CanCancelUntilDate",
      "Value": "2025-09-16T14:09:21.722Z"
    },
    {
      "Name": "CommitmentEndDate",
      "Value": "2025-09-16T14:09:21.722Z"
    }
  ]
}

<GetSubscriptionDetailResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <Aliases xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>def.spc.com</d2p1:string>
  </Aliases>
  <AvailableActions>
    <CanCancel>true</CanCancel>
    <CanConfigure>true</CanConfigure>
    <CanDowngrade>false</CanDowngrade>
    <CanRestore>true</CanRestore>
    <CanSuspend>false</CanSuspend>
    <CanUpgrade>false</CanUpgrade>
  </AvailableActions>
  <BillingFrequency>Monthly</BillingFrequency>
  <CancellationDate>2025-07-23T14:09:21.7227565Z</CancellationDate>
  <CancellationGracePeriod>27</CancellationGracePeriod>
  <Categories xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Recovery</d2p1:string>
  </Categories>
  <Domain>spg.com</Domain>
  <ExpirationBehavior>AutoRenew</ExpirationBehavior>
  <ExpirationDate>2025-09-16T14:09:21.7227565Z</ExpirationDate>
  <IsTrial>false</IsTrial>
  <ProductName>Cloud Backup</ProductName>
  <ScheduledUninstallDate>2025-09-17T14:09:21.7227565Z</ScheduledUninstallDate>
  <StartDate>2025-07-18T14:09:21.7227565Z</StartDate>
  <SubscriptionKey>192837-TESDF-1-spg.com</SubscriptionKey>
  <SubscriptionStatus>Active</SubscriptionStatus>
  <SubscriptionTerm>Monthly</SubscriptionTerm>
  <ConfigurableSubscriptionDetails>
    <GetSubscriptionDetailResponseModel.ConfigurableSubscriptionDetail>
      <Name>SubscriptionQuantity</Name>
      <Value>10</Value>
    </GetSubscriptionDetailResponseModel.ConfigurableSubscriptionDetail>
  </ConfigurableSubscriptionDetails>
  <ReadonlySubscriptionDetails>
    <GetSubscriptionDetailResponseModel.ReadonlySubscriptionDetail>
      <Name>TotalLicenses</Name>
      <Value>15</Value>
    </GetSubscriptionDetailResponseModel.ReadonlySubscriptionDetail>
    <GetSubscriptionDetailResponseModel.ReadonlySubscriptionDetail>
      <Name>AssignedLicenses</Name>
      <Value>10</Value>
    </GetSubscriptionDetailResponseModel.ReadonlySubscriptionDetail>
    <GetSubscriptionDetailResponseModel.ReadonlySubscriptionDetail>
      <Name>UnassignedLicenses</Name>
      <Value>5</Value>
    </GetSubscriptionDetailResponseModel.ReadonlySubscriptionDetail>
    <GetSubscriptionDetailResponseModel.ReadonlySubscriptionDetail>
      <Name>CanCancelUntilDate</Name>
      <Value>2025-09-16T14:09:21.722Z</Value>
    </GetSubscriptionDetailResponseModel.ReadonlySubscriptionDetail>
    <GetSubscriptionDetailResponseModel.ReadonlySubscriptionDetail>
      <Name>CommitmentEndDate</Name>
      <Value>2025-09-16T14:09:21.722Z</Value>
    </GetSubscriptionDetailResponseModel.ReadonlySubscriptionDetail>
  </ReadonlySubscriptionDetails>
</GetSubscriptionDetailResponseModel>