Skip to main content

SubscriptionState

Subscription lifecycle state returned by subscription.

enum SubscriptionState {
  TEMPORARY
  CANCELING
  CANCELED
  EXPIRING
  TRIAL_CC_FAILED
  EXPIRED
  INACTIVE
  ACTIVE
}

Values​

SubscriptionState.TEMPORARY​

The customer created a user account but did not choose a plan

SubscriptionState.CANCELING​

The user has manually canceled the plan but there are still days remaining on the subscription

SubscriptionState.CANCELED​

The user canceled their plan

SubscriptionState.EXPIRING​

The user's payment has failed but they're still within the grace period

SubscriptionState.TRIAL_CC_FAILED​

Trial requires a valid credit card and the user has not provided one

SubscriptionState.EXPIRED​

Expiration is complete

SubscriptionState.INACTIVE​

The user can't access their account until they reactivate it.

SubscriptionState.ACTIVE​

The user is on an active plan

Member Of​

CapabilitySubscription object