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	addAllAmendment(List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment> elements)	Add all elements to `amendments` list.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	addAllPhase(List<InvoiceCreatePreviewParams.ScheduleDetails.Phase> elements)	Add all elements to `phases` list.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	addAllPrebilling(List<InvoiceCreatePreviewParams.ScheduleDetails.Prebilling> elements)	Add all elements to `prebilling` list.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	addAmendment(InvoiceCreatePreviewParams.ScheduleDetails.Amendment element)	Add an element to `amendments` list.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	addPhase(InvoiceCreatePreviewParams.ScheduleDetails.Phase element)	Add an element to `phases` list.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	addPrebilling(InvoiceCreatePreviewParams.ScheduleDetails.Prebilling element)	Add an element to `prebilling` 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	setBillingBehavior(InvoiceCreatePreviewParams.ScheduleDetails.BillingBehavior billingBehavior)	Configures when the subscription schedule generates prorations for phase transitions.
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	setPrebilling(EmptyParam prebilling)	Provide any time periods to bill in advance.
InvoiceCreatePreviewParams.ScheduleDetails.Builder	setPrebilling(List<InvoiceCreatePreviewParams.ScheduleDetails.Prebilling> prebilling)	Provide any time periods to bill in advance.
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.

addAmendment

public InvoiceCreatePreviewParams.ScheduleDetails.Builder addAmendment(InvoiceCreatePreviewParams.ScheduleDetails.Amendment element)

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

addAllAmendment

public InvoiceCreatePreviewParams.ScheduleDetails.Builder addAllAmendment(List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment> elements)

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

setBillingBehavior

public InvoiceCreatePreviewParams.ScheduleDetails.Builder setBillingBehavior(InvoiceCreatePreviewParams.ScheduleDetails.BillingBehavior billingBehavior)

Configures when the subscription schedule generates prorations for phase transitions. Possible values are prorate_on_next_phase or prorate_up_front with the default being prorate_on_next_phase. prorate_on_next_phase will apply phase changes and generate prorations at transition time. prorate_up_front will bill for all phases within the current billing cycle up front.

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.

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.

addPrebilling

public InvoiceCreatePreviewParams.ScheduleDetails.Builder addPrebilling(InvoiceCreatePreviewParams.ScheduleDetails.Prebilling element)

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

addAllPrebilling

public InvoiceCreatePreviewParams.ScheduleDetails.Builder addAllPrebilling(List<InvoiceCreatePreviewParams.ScheduleDetails.Prebilling> elements)

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

setPrebilling

public InvoiceCreatePreviewParams.ScheduleDetails.Builder setPrebilling(EmptyParam prebilling)

Provide any time periods to bill in advance.

setPrebilling

public InvoiceCreatePreviewParams.ScheduleDetails.Builder setPrebilling(List<InvoiceCreatePreviewParams.ScheduleDetails.Prebilling> prebilling)

Provide any time periods to bill in advance.

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.