Package com.stripe.param.billingportal

Class ConfigurationCreateParams.Features.SubscriptionUpdate.Builder

java.lang.Object

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

Enclosing class:

ConfigurationCreateParams.Features.SubscriptionUpdate

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	addAllDefaultAllowedUpdate(List<ConfigurationCreateParams.Features.SubscriptionUpdate.DefaultAllowedUpdate> elements)	Add all elements to `defaultAllowedUpdates` list.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	addAllProduct(List<ConfigurationCreateParams.Features.SubscriptionUpdate.Product> elements)	Add all elements to `products` list.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	addDefaultAllowedUpdate(ConfigurationCreateParams.Features.SubscriptionUpdate.DefaultAllowedUpdate element)	Add an element to `defaultAllowedUpdates` list.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	addProduct(ConfigurationCreateParams.Features.SubscriptionUpdate.Product element)	Add an element to `products` list.
ConfigurationCreateParams.Features.SubscriptionUpdate	build()	Finalize and obtain parameter instance from this builder.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	setBillingCycleAnchor(ConfigurationCreateParams.Features.SubscriptionUpdate.BillingCycleAnchor billingCycleAnchor)	Determines the value to use for the billing cycle anchor on subscription updates.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	setDefaultAllowedUpdates(EmptyParam defaultAllowedUpdates)	The types of subscription updates that are supported.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	setDefaultAllowedUpdates(List<ConfigurationCreateParams.Features.SubscriptionUpdate.DefaultAllowedUpdate> defaultAllowedUpdates)	The types of subscription updates that are supported.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	setEnabled(Boolean enabled)	Required. Whether the feature is enabled.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	setProducts(EmptyParam products)	The list of up to 10 products that support subscription updates.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	setProducts(List<ConfigurationCreateParams.Features.SubscriptionUpdate.Product> products)	The list of up to 10 products that support subscription updates.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	setProrationBehavior(ConfigurationCreateParams.Features.SubscriptionUpdate.ProrationBehavior prorationBehavior)	Determines how to handle prorations resulting from subscription updates.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	setScheduleAtPeriodEnd(ConfigurationCreateParams.Features.SubscriptionUpdate.ScheduleAtPeriodEnd scheduleAtPeriodEnd)	Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
ConfigurationCreateParams.Features.SubscriptionUpdate.Builder	setTrialUpdateBehavior(ConfigurationCreateParams.Features.SubscriptionUpdate.TrialUpdateBehavior trialUpdateBehavior)	The behavior when updating a subscription that is trialing.

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.SubscriptionUpdate build()

Finalize and obtain parameter instance from this builder.

setBillingCycleAnchor

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder setBillingCycleAnchor(ConfigurationCreateParams.Features.SubscriptionUpdate.BillingCycleAnchor billingCycleAnchor)

Determines the value to use for the billing cycle anchor on subscription updates. Valid values are now or unchanged, and the default value is unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.

addDefaultAllowedUpdate

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder addDefaultAllowedUpdate(ConfigurationCreateParams.Features.SubscriptionUpdate.DefaultAllowedUpdate element)

Add an element to `defaultAllowedUpdates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ConfigurationCreateParams.Features.SubscriptionUpdate.defaultAllowedUpdates for the field documentation.

addAllDefaultAllowedUpdate

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder addAllDefaultAllowedUpdate(List<ConfigurationCreateParams.Features.SubscriptionUpdate.DefaultAllowedUpdate> elements)

Add all elements to `defaultAllowedUpdates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ConfigurationCreateParams.Features.SubscriptionUpdate.defaultAllowedUpdates for the field documentation.

setDefaultAllowedUpdates

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder setDefaultAllowedUpdates(EmptyParam defaultAllowedUpdates)

The types of subscription updates that are supported. When empty, subscriptions are not updateable.

setDefaultAllowedUpdates

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder setDefaultAllowedUpdates(List<ConfigurationCreateParams.Features.SubscriptionUpdate.DefaultAllowedUpdate> defaultAllowedUpdates)

The types of subscription updates that are supported. When empty, subscriptions are not updateable.

setEnabled

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

Required. Whether the feature is enabled.

putExtraParam

public ConfigurationCreateParams.Features.SubscriptionUpdate.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.SubscriptionUpdate.extraParams for the field documentation.

putAllExtraParam

public ConfigurationCreateParams.Features.SubscriptionUpdate.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.SubscriptionUpdate.extraParams for the field documentation.

addProduct

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder addProduct(ConfigurationCreateParams.Features.SubscriptionUpdate.Product element)

Add an element to `products` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ConfigurationCreateParams.Features.SubscriptionUpdate.products for the field documentation.

addAllProduct

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder addAllProduct(List<ConfigurationCreateParams.Features.SubscriptionUpdate.Product> elements)

Add all elements to `products` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ConfigurationCreateParams.Features.SubscriptionUpdate.products for the field documentation.

setProducts

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder setProducts(EmptyParam products)

The list of up to 10 products that support subscription updates.

setProducts

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder setProducts(List<ConfigurationCreateParams.Features.SubscriptionUpdate.Product> products)

The list of up to 10 products that support subscription updates.

setProrationBehavior

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

Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice.

setScheduleAtPeriodEnd

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder setScheduleAtPeriodEnd(ConfigurationCreateParams.Features.SubscriptionUpdate.ScheduleAtPeriodEnd scheduleAtPeriodEnd)

Setting to control when an update should be scheduled at the end of the period instead of applying immediately.

setTrialUpdateBehavior

public ConfigurationCreateParams.Features.SubscriptionUpdate.Builder setTrialUpdateBehavior(ConfigurationCreateParams.Features.SubscriptionUpdate.TrialUpdateBehavior trialUpdateBehavior)

The behavior when updating a subscription that is trialing.