Package com.stripe.param

Class SubscriptionScheduleUpdateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionScheduleUpdateParams

public class SubscriptionScheduleUpdateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionScheduleUpdateParams.Builder
static class	SubscriptionScheduleUpdateParams.DefaultSettings
static enum	SubscriptionScheduleUpdateParams.EndBehavior
static class	SubscriptionScheduleUpdateParams.Phase
static enum	SubscriptionScheduleUpdateParams.ProrationBehavior

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method	Description
static SubscriptionScheduleUpdateParams.Builder	builder()
SubscriptionScheduleUpdateParams.DefaultSettings	getDefaultSettings()	Object representing the subscription schedule's default settings.
SubscriptionScheduleUpdateParams.EndBehavior	getEndBehavior()	Behavior of the subscription schedule and underlying subscription when it ends.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Object	getMetadata()	Set of key-value pairs that you can attach to an object.
List<SubscriptionScheduleUpdateParams.Phase>	getPhases()	List representing phases of the subscription schedule.
SubscriptionScheduleUpdateParams.ProrationBehavior	getProrationBehavior()	If the update changes the current phase, indicates whether the changes should be prorated.

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SubscriptionScheduleUpdateParams.Builder builder()

getDefaultSettings

public SubscriptionScheduleUpdateParams.DefaultSettings getDefaultSettings()

Object representing the subscription schedule's default settings.

getEndBehavior

public SubscriptionScheduleUpdateParams.EndBehavior getEndBehavior()

Behavior of the subscription schedule and underlying subscription 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.

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

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.

getMetadata

public Object getMetadata()

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.

getPhases

public List<SubscriptionScheduleUpdateParams.Phase> getPhases()

List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase. Note that past phases can be omitted.

getProrationBehavior

public SubscriptionScheduleUpdateParams.ProrationBehavior getProrationBehavior()

If the update changes the current phase, indicates whether the changes should be prorated. The default value is create_prorations.