subscriptionState property

String? subscriptionState
getter/setter pair

The current state of the subscription. Possible string values are:

  • "SUBSCRIPTION_STATE_UNSPECIFIED" : Unspecified subscription state.
  • "SUBSCRIPTION_STATE_PENDING" : Subscription was created but awaiting payment during signup. In this state, all items are awaiting payment.
  • "SUBSCRIPTION_STATE_ACTIVE" : Subscription is active. - (1) If the subscription is an auto renewing plan, at least one item is auto_renew_enabled and not expired. - (2) If the subscription is a prepaid plan, at least one item is not expired.
  • "SUBSCRIPTION_STATE_PAUSED" : Subscription is paused. The state is only available when the subscription is an auto renewing plan. In this state, all items are in paused state.
  • "SUBSCRIPTION_STATE_IN_GRACE_PERIOD" : Subscription is in grace period. The state is only available when the subscription is an auto renewing plan. In this state, all items are in grace period.
  • "SUBSCRIPTION_STATE_ON_HOLD" : Subscription is on hold (suspended). The state is only available when the subscription is an auto renewing plan. In this state, all items are on hold.
  • "SUBSCRIPTION_STATE_CANCELED" : Subscription is canceled but not expired yet. The state is only available when the subscription is an auto renewing plan. All items have auto_renew_enabled set to false.
  • "SUBSCRIPTION_STATE_EXPIRED" : Subscription is expired. All items have expiry_time in the past.

Implementation

core.String? subscriptionState;