Package com.stripe.param

Class InvoiceCreatePreviewParams.ScheduleDetails

java.lang.Object

com.stripe.param.InvoiceCreatePreviewParams.ScheduleDetails

Enclosing class:

InvoiceCreatePreviewParams

public static class InvoiceCreatePreviewParams.ScheduleDetails
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvoiceCreatePreviewParams.ScheduleDetails.Builder
static enum	InvoiceCreatePreviewParams.ScheduleDetails.EndBehavior
static class	InvoiceCreatePreviewParams.ScheduleDetails.Phase
static enum	InvoiceCreatePreviewParams.ScheduleDetails.ProrationBehavior

Method Summary

Modifier and Type	Method	Description
static InvoiceCreatePreviewParams.ScheduleDetails.Builder	builder()
InvoiceCreatePreviewParams.ScheduleDetails.EndBehavior	getEndBehavior()	Behavior of the subscription schedule and underlying subscription when it ends.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
List<InvoiceCreatePreviewParams.ScheduleDetails.Phase>	getPhases()	List representing phases of the subscription schedule.
InvoiceCreatePreviewParams.ScheduleDetails.ProrationBehavior	getProrationBehavior()	In cases where the schedule_details params update the currently active phase, specifies if and how to prorate at the time of the request.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static InvoiceCreatePreviewParams.ScheduleDetails.Builder builder()

getEndBehavior

public InvoiceCreatePreviewParams.ScheduleDetails.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.

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.

getPhases

public List<InvoiceCreatePreviewParams.ScheduleDetails.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.

getProrationBehavior

public InvoiceCreatePreviewParams.ScheduleDetails.ProrationBehavior getProrationBehavior()

In cases where the schedule_details params update the currently active phase, specifies if and how to prorate at the time of the request.