suspendMode property

String? suspendMode
getter/setter pair

The mode to suspend the subscription.

It's required for partners to specify the suspend mode, whether suspend immediately and indefinitely, or cancel the subscription after grace_period_millis or auto_cancel_duration_millis if it's not resumed.

Optional. Possible string values are:

  • "SUSPEND_MODE_UNSPECIFIED" : The default value. Suspend the subscription, and the subscription will stay suspended indefinitely.
  • "SUSPEND_MODE_CANCEL_AFTER_GRACE_PERIOD" : Suspend the subscription, and the subscription will be auto cancelled after the grace period. Contract terms dictate how long the grace period is.
  • "SUSPEND_MODE_CANCEL_AFTER_RETENTION_PERIOD" : Suspend the subscription, and the subscription will be auto cancelled after the retention period. Contract terms dictate how long the retention period is.

Implementation

core.String? suspendMode;