VerifyEntitlementTokenResponse.SubscriptionState property
Gets or sets the subscription status of the app license.
Namespace: VerificationSvc
Assembly: SP15MrefVerificationSvc (in SP15MrefVerificationSvc.dll)
Syntax
'Declaration
Public Property SubscriptionState As String
Get
Set
'Usage
Dim instance As VerifyEntitlementTokenResponse
Dim value As String
value = instance.SubscriptionState
instance.SubscriptionState = value
public string SubscriptionState { get; set; }
Property value
Type: System.String
An integer between 0 and 4 that represents the subscriptions status of the app license.
Remarks
Note
The properties of the VerifyEntitlementTokenResponse object are provided for developers to verify property values of an app license. Setting these properties only changes the local copy of the license token; it has no effect on the license stored by the Office Store.
Valid values include:
Value |
Description |
|---|---|
0 |
NotApplicable The app license is not for a subscription app. |
1 |
Active The app license subscription is currently paid for. Recommended user experience: Full app experience. |
2 |
FailedPayment The automatic monthly billing for the app license subscription has failed. There are several reasons payment may have failed. For example, the credit card being billed might have expired. When payment fails, emails are sent to the Microsoft account paying for the app license. However, the user might not check their Microsoft account email on a frequent basis, or, in the case of apps for SharePoint, the person paying for the app license may not actually be the person using the app license. Recommended user experience: Present UI in your app alerting the user of the problem with billing, so that they can resolve it. |
3 |
Canceled The app license subscription has been canceled, and final monthly billing period the user has paid for has expired. Recommended user experience: Present the user with information that their subscription has been cancelled. Provide information about your app, along with a hyperlink to your app’s Office Store listing page, so they are encouraged to renew their subscription. |
4 |
DelayedCancel The app license subscription has been canceled, but the subscription is still within the current, monthly billing period the user has paid for. Once the current, paid monthly billing period expires, the subscription status changes to Canceled. Recommended user experience: Full app experience. Additionally, you may want to present contextual UI to ask the user for feedback on why they are canceling their subscription, or to enourage them to re-subscribe. |
See also
Reference
VerifyEntitlementTokenResponse class
VerifyEntitlementTokenResponse members
Other resources
License your apps for Office and SharePoint
How to: Add license checks to your apps for Office