Package com.stripe.param.billingportal

Class ConfigurationCreateParams.Features.SubscriptionCancel.Builder

java.lang.Object

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

Enclosing class:

ConfigurationCreateParams.Features.SubscriptionCancel

public static class ConfigurationCreateParams.Features.SubscriptionCancel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ConfigurationCreateParams.Features.SubscriptionCancel	build()	Finalize and obtain parameter instance from this builder.
ConfigurationCreateParams.Features.SubscriptionCancel.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
ConfigurationCreateParams.Features.SubscriptionCancel.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
ConfigurationCreateParams.Features.SubscriptionCancel.Builder	setCancellationReason(ConfigurationCreateParams.Features.SubscriptionCancel.CancellationReason cancellationReason)	Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer.
ConfigurationCreateParams.Features.SubscriptionCancel.Builder	setEnabled(Boolean enabled)	Required. Whether the feature is enabled.
ConfigurationCreateParams.Features.SubscriptionCancel.Builder	setMode(ConfigurationCreateParams.Features.SubscriptionCancel.Mode mode)	Whether to cancel subscriptions immediately or at the end of the billing period.
ConfigurationCreateParams.Features.SubscriptionCancel.Builder	setProrationBehavior(ConfigurationCreateParams.Features.SubscriptionCancel.ProrationBehavior prorationBehavior)	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

Constructor Details

Builder

public Builder()

Method Details

build

public ConfigurationCreateParams.Features.SubscriptionCancel build()

Finalize and obtain parameter instance from this builder.

setCancellationReason

public ConfigurationCreateParams.Features.SubscriptionCancel.Builder setCancellationReason(ConfigurationCreateParams.Features.SubscriptionCancel.CancellationReason cancellationReason)

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

setEnabled

public ConfigurationCreateParams.Features.SubscriptionCancel.Builder setEnabled(Boolean enabled)

Required. Whether the feature is enabled.

putExtraParam

public ConfigurationCreateParams.Features.SubscriptionCancel.Builder putExtraParam(String key,
 Object value)

Add a key/value pair 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.SubscriptionCancel.extraParams for the field documentation.

putAllExtraParam

public ConfigurationCreateParams.Features.SubscriptionCancel.Builder putAllExtraParam(Map<String,Object> map)

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.SubscriptionCancel.extraParams for the field documentation.

setMode

public ConfigurationCreateParams.Features.SubscriptionCancel.Builder setMode(ConfigurationCreateParams.Features.SubscriptionCancel.Mode mode)

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

setProrationBehavior

public ConfigurationCreateParams.Features.SubscriptionCancel.Builder setProrationBehavior(ConfigurationCreateParams.Features.SubscriptionCancel.ProrationBehavior prorationBehavior)

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.