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 and Description
static class	SubscriptionScheduleUpdateParams.Builder
static class	SubscriptionScheduleUpdateParams.DefaultSettings
static class	SubscriptionScheduleUpdateParams.EndBehavior
static class	SubscriptionScheduleUpdateParams.Phase
static class	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 and Description
static SubscriptionScheduleUpdateParams.Builder	builder()
SubscriptionScheduleUpdateParams.DefaultSettings	getDefaultSettings() Object representing the subscription schedule's default settings.
SubscriptionScheduleUpdateParams.EndBehavior	getEndBehavior() Configures how the subscription schedule behaves when it ends.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
java.util.List<SubscriptionScheduleUpdateParams.Phase>	getPhases() List representing phases of the subscription schedule.
java.lang.Boolean	getProrate() This field has been renamed to proration_behavior.
SubscriptionScheduleUpdateParams.ProrationBehavior	getProrationBehavior() If the update changes the current phase, indicates if the changes should be prorated.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SubscriptionScheduleUpdateParams.Builder builder()

getDefaultSettings

public SubscriptionScheduleUpdateParams.DefaultSettings getDefaultSettings()

Object representing the subscription schedule's default settings.

getEndBehavior

public SubscriptionScheduleUpdateParams.EndBehavior getEndBehavior()

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.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.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 java.util.Map<java.lang.String,java.lang.String> 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 java.util.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.

getProrate

public java.lang.Boolean getProrate()

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.

getProrationBehavior

public SubscriptionScheduleUpdateParams.ProrationBehavior getProrationBehavior()

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