SubscriptionState

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

Items

Name	Value	Description
NeverSubscribed	0	User has never subscribed to the product.
SubscribedWillRenew	1	Subscription is active and will renew.
SubscribedWillNotRenew	2	Subscription is active and will not renew.
SubscribedRenewalPaymentPending	3	Subscription is active and renewal payment is pending.
Expired	4	Subscription has expired.

NeverSubscribed

User has never subscribed to the product.

Field	Value
value	0

SubscribedWillRenew

Subscription is active and will renew.

Field	Value
value	1

SubscribedWillNotRenew

Subscription is active and will not renew.

Field	Value
value	2

SubscribedRenewalPaymentPending

Subscription is active and renewal payment is pending.

Field	Value
value	3

Expired

Subscription has expired.

Field	Value
value	4