GetSubscriptionDetailResponseModel

Provides detail of a subscription.

NameDescriptionTypeAdditional 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.