Package com.stripe.param

Class InvoiceCreatePreviewParams.ScheduleDetails.Builder

java.lang.Object

com.stripe.param.InvoiceCreatePreviewParams.ScheduleDetails.Builder

Enclosing class:

InvoiceCreatePreviewParams.ScheduleDetails

public static class InvoiceCreatePreviewParams.ScheduleDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InvoiceCreatePreviewParams.ScheduleDetails.Builder	addAllPauseSchedule(List<InvoiceCreatePreviewParams.ScheduleDetails.PauseSchedule> elements)	Add all elements to `pauseSchedules` list.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	addAllPhase(List<InvoiceCreatePreviewParams.ScheduleDetails.Phase> elements)	Add all elements to `phases` list.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	addPauseSchedule(InvoiceCreatePreviewParams.ScheduleDetails.PauseSchedule element)	Add an element to `pauseSchedules` list.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	addPhase(InvoiceCreatePreviewParams.ScheduleDetails.Phase element)	Add an element to `phases` list.
InvoiceCreatePreviewParams.ScheduleDetails	build()	Finalize and obtain parameter instance from this builder.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	setBillingMode(InvoiceCreatePreviewParams.ScheduleDetails.BillingMode billingMode)	Controls how prorations and invoices for subscriptions are calculated and orchestrated.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	setEndBehavior(InvoiceCreatePreviewParams.ScheduleDetails.EndBehavior endBehavior)	Behavior of the subscription schedule and underlying subscription when it ends.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	setPauseSchedules(EmptyParam pauseSchedules)	The subscription's pause behavior and optional resume behavior.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	setPauseSchedules(List<InvoiceCreatePreviewParams.ScheduleDetails.PauseSchedule> pauseSchedules)	The subscription's pause behavior and optional resume behavior.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	setProrationBehavior(InvoiceCreatePreviewParams.ScheduleDetails.ProrationBehavior prorationBehavior)	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

Constructor Details

Builder

public Builder()

Method Details

build

public InvoiceCreatePreviewParams.ScheduleDetails build()

Finalize and obtain parameter instance from this builder.

setBillingMode

public InvoiceCreatePreviewParams.ScheduleDetails.Builder setBillingMode(InvoiceCreatePreviewParams.ScheduleDetails.BillingMode billingMode)

Controls how prorations and invoices for subscriptions are calculated and orchestrated.

setEndBehavior

public InvoiceCreatePreviewParams.ScheduleDetails.Builder setEndBehavior(InvoiceCreatePreviewParams.ScheduleDetails.EndBehavior endBehavior)

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.

putExtraParam

public InvoiceCreatePreviewParams.ScheduleDetails.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 InvoiceCreatePreviewParams.ScheduleDetails.extraParams for the field documentation.

putAllExtraParam

public InvoiceCreatePreviewParams.ScheduleDetails.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 InvoiceCreatePreviewParams.ScheduleDetails.extraParams for the field documentation.

addPauseSchedule

public InvoiceCreatePreviewParams.ScheduleDetails.Builder addPauseSchedule(InvoiceCreatePreviewParams.ScheduleDetails.PauseSchedule element)

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

addAllPauseSchedule

public InvoiceCreatePreviewParams.ScheduleDetails.Builder addAllPauseSchedule(List<InvoiceCreatePreviewParams.ScheduleDetails.PauseSchedule> elements)

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

setPauseSchedules

public InvoiceCreatePreviewParams.ScheduleDetails.Builder setPauseSchedules(EmptyParam pauseSchedules)

The subscription's pause behavior and optional resume behavior. You can provide one entry. Include its key to update an existing pause schedule. Omit pause_schedules to leave the existing schedule unchanged, or pass an empty string ("") to clear it.

setPauseSchedules

public InvoiceCreatePreviewParams.ScheduleDetails.Builder setPauseSchedules(List<InvoiceCreatePreviewParams.ScheduleDetails.PauseSchedule> pauseSchedules)

The subscription's pause behavior and optional resume behavior. You can provide one entry. Include its key to update an existing pause schedule. Omit pause_schedules to leave the existing schedule unchanged, or pass an empty string ("") to clear it.

addPhase

public InvoiceCreatePreviewParams.ScheduleDetails.Builder addPhase(InvoiceCreatePreviewParams.ScheduleDetails.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 InvoiceCreatePreviewParams.ScheduleDetails.phases for the field documentation.

addAllPhase

public InvoiceCreatePreviewParams.ScheduleDetails.Builder addAllPhase(List<InvoiceCreatePreviewParams.ScheduleDetails.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 InvoiceCreatePreviewParams.ScheduleDetails.phases for the field documentation.

setProrationBehavior

public InvoiceCreatePreviewParams.ScheduleDetails.Builder setProrationBehavior(InvoiceCreatePreviewParams.ScheduleDetails.ProrationBehavior prorationBehavior)

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