com.stripe.param

Class SubscriptionScheduleUpdateParams.Builder

java.lang.Object

com.stripe.param.SubscriptionScheduleUpdateParams.Builder

Enclosing class:

SubscriptionScheduleUpdateParams

public static class SubscriptionScheduleUpdateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SubscriptionScheduleUpdateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
SubscriptionScheduleUpdateParams.Builder	addAllPhase(java.util.List<SubscriptionScheduleUpdateParams.Phase> elements) Add all elements to `phases` list.
SubscriptionScheduleUpdateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
SubscriptionScheduleUpdateParams.Builder	addPhase(SubscriptionScheduleUpdateParams.Phase element) Add an element to `phases` list.
SubscriptionScheduleUpdateParams	build() Finalize and obtain parameter instance from this builder.
SubscriptionScheduleUpdateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
SubscriptionScheduleUpdateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
SubscriptionScheduleUpdateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
SubscriptionScheduleUpdateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
SubscriptionScheduleUpdateParams.Builder	setDefaultSettings(SubscriptionScheduleUpdateParams.DefaultSettings defaultSettings) Object representing the subscription schedule's default settings.
SubscriptionScheduleUpdateParams.Builder	setEndBehavior(SubscriptionScheduleUpdateParams.EndBehavior endBehavior) Configures how the subscription schedule behaves when it ends.
SubscriptionScheduleUpdateParams.Builder	setMetadata(EmptyParam metadata) Set of key-value pairs that you can attach to an object.
SubscriptionScheduleUpdateParams.Builder	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Set of key-value pairs that you can attach to an object.
SubscriptionScheduleUpdateParams.Builder	setProrate(java.lang.Boolean prorate) This field has been renamed to proration_behavior.
SubscriptionScheduleUpdateParams.Builder	setProrationBehavior(SubscriptionScheduleUpdateParams.ProrationBehavior prorationBehavior) If the update changes the current phase, indicates if the changes should be prorated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public SubscriptionScheduleUpdateParams build()

Finalize and obtain parameter instance from this builder.

setDefaultSettings

public SubscriptionScheduleUpdateParams.Builder setDefaultSettings(SubscriptionScheduleUpdateParams.DefaultSettings defaultSettings)

Object representing the subscription schedule's default settings.

setEndBehavior

public SubscriptionScheduleUpdateParams.Builder setEndBehavior(SubscriptionScheduleUpdateParams.EndBehavior endBehavior)

Configures how the subscription schedule behaves when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running.cancel will end the subscription schedule and cancel the underlying subscription.

addExpand

public SubscriptionScheduleUpdateParams.Builder addExpand(java.lang.String element)

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

addAllExpand

public SubscriptionScheduleUpdateParams.Builder addAllExpand(java.util.List<java.lang.String> elements)

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

putExtraParam

public SubscriptionScheduleUpdateParams.Builder putExtraParam(java.lang.String key,
                                                              java.lang.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 SubscriptionScheduleUpdateParams.extraParams for the field documentation.

putAllExtraParam

public SubscriptionScheduleUpdateParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.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 SubscriptionScheduleUpdateParams.extraParams for the field documentation.

putMetadata

public SubscriptionScheduleUpdateParams.Builder putMetadata(java.lang.String key,
                                                            java.lang.String value)

Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionScheduleUpdateParams.metadata for the field documentation.

putAllMetadata

public SubscriptionScheduleUpdateParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)

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

setMetadata

public SubscriptionScheduleUpdateParams.Builder setMetadata(EmptyParam metadata)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

setMetadata

public SubscriptionScheduleUpdateParams.Builder setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

addPhase

public SubscriptionScheduleUpdateParams.Builder addPhase(SubscriptionScheduleUpdateParams.Phase element)

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

addAllPhase

public SubscriptionScheduleUpdateParams.Builder addAllPhase(java.util.List<SubscriptionScheduleUpdateParams.Phase> elements)

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

setProrate

public SubscriptionScheduleUpdateParams.Builder setProrate(java.lang.Boolean prorate)

This field has been renamed to proration_behavior. prorate=true can be replaced with proration_behavior=create_prorations and prorate=false can be replaced with proration_behavior=none.

setProrationBehavior

public SubscriptionScheduleUpdateParams.Builder setProrationBehavior(SubscriptionScheduleUpdateParams.ProrationBehavior prorationBehavior)

If the update changes the current phase, indicates if the changes should be prorated. Possible values are create_prorations or none, and the default value is create_prorations.