Package com.stripe.param.billingportal

Class ConfigurationCreateParams.Features.SubscriptionCancel

java.lang.Object

com.stripe.param.billingportal.ConfigurationCreateParams.Features.SubscriptionCancel

Enclosing class:

ConfigurationCreateParams.Features

public static class ConfigurationCreateParams.Features.SubscriptionCancel
extends Object

Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ConfigurationCreateParams.Features.PaymentMethodUpdate.extraParams for the field documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigurationCreateParams.Features.SubscriptionCancel.Builder
static class	ConfigurationCreateParams.Features.SubscriptionCancel.CancellationReason
static enum	ConfigurationCreateParams.Features.SubscriptionCancel.Mode
static enum	ConfigurationCreateParams.Features.SubscriptionCancel.ProrationBehavior

Method Summary

Modifier and Type	Method	Description
static ConfigurationCreateParams.Features.SubscriptionCancel.Builder	builder()
ConfigurationCreateParams.Features.SubscriptionCancel.CancellationReason	getCancellationReason()	Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer.
Boolean	getEnabled()	Required. Whether the feature is enabled.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
ConfigurationCreateParams.Features.SubscriptionCancel.Mode	getMode()	Whether to cancel subscriptions immediately or at the end of the billing period.
ConfigurationCreateParams.Features.SubscriptionCancel.ProrationBehavior	getProrationBehavior()	Whether to create prorations when canceling subscriptions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static ConfigurationCreateParams.Features.SubscriptionCancel.Builder builder()

getCancellationReason

public ConfigurationCreateParams.Features.SubscriptionCancel.CancellationReason getCancellationReason()

Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer.

getEnabled

public Boolean getEnabled()

Required. Whether the feature is enabled.

getExtraParams

public Map<String,Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getMode

public ConfigurationCreateParams.Features.SubscriptionCancel.Mode getMode()

Whether to cancel subscriptions immediately or at the end of the billing period.

getProrationBehavior

public ConfigurationCreateParams.Features.SubscriptionCancel.ProrationBehavior getProrationBehavior()

Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations, which is only compatible with mode=immediately. No prorations are generated when canceling a subscription at the end of its natural billing period.