Skip to content

SubscriptionState

Not yet Enum

Describes the current subscription state of a user's in-experience subscription product.

Not implemented in Nova

This enum is missing from Nova. Scripts that reference it will fail.

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

Items

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

Roblox reference: SubscriptionState