SubscriptionState
Describes the current subscription state of a user's in-experience subscription product.
Items 5
| History | Name | Value | Description | |
|---|---|---|---|---|
| 614 | NeverSubscribed | 0 | User has never subscribed to the product. | |
| 614 | SubscribedWillRenew | 1 | Subscription is active and will renew. | |
| 614 | SubscribedWillNotRenew | 2 | Subscription is active and will not renew. | |
| 614 | SubscribedRenewalPaymentPending | 3 | Subscription is active and renewal payment is pending. | |
| 614 | Expired | 4 | Subscription has expired. |
Description
The SubscriptionState enum describes the current subscription state of a
user with respect to a specific in-experience subscription product. It is
returned in the SubscriptionState key of the table from
MarketplaceService:GetUserSubscriptionDetailsAsync(), which must be
called from a server-side Script. See SubscriptionState for the
lifecycle values (never subscribed, active with or without renewal, renewal
payment pending, and expired).