Package com.stripe.param

Class InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder

java.lang.Object

com.stripe.param.InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder

Enclosing class:

InvoiceCreatePreviewParams.ScheduleDetails.Amendment

public static class InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	addAllBillingSchedulesAction(List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingSchedulesAction> elements)	Add all elements to `billingSchedulesActions` list.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	addAllDiscountAction(List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.DiscountAction> elements)	Add all elements to `discountActions` list.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	addAllItemAction(List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.ItemAction> elements)	Add all elements to `itemActions` list.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	addAllMetadataAction(List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.MetadataAction> elements)	Add all elements to `metadataActions` list.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	addBillingSchedulesAction(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingSchedulesAction element)	Add an element to `billingSchedulesActions` list.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	addDiscountAction(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.DiscountAction element)	Add an element to `discountActions` list.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	addItemAction(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.ItemAction element)	Add an element to `itemActions` list.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	addMetadataAction(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.MetadataAction element)	Add an element to `metadataActions` list.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment	build()	Finalize and obtain parameter instance from this builder.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	setAmendmentEnd(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.AmendmentEnd amendmentEnd)	Details to identify the end of the time range modified by the proposed change.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	setAmendmentStart(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.AmendmentStart amendmentStart)	Required. Details to identify the earliest timestamp where the proposed change should take effect.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	setBillingCycleAnchor(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingCycleAnchor billingCycleAnchor)	For point-in-time amendments (having no amendment_end), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the amendment_start timestamp.For time-span based amendments (having both amendment_start and amendment_end), the only value valid is automatic, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	setEffectiveAt(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.EffectiveAt effectiveAt)	Configures how the subscription schedule handles billing for phase transitions.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	setProrationBehavior(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.ProrationBehavior prorationBehavior)	Changes to how Stripe handles prorations during the amendment time span.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	setSetPauseCollection(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.SetPauseCollection setPauseCollection)	Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	setSetScheduleEnd(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.SetScheduleEnd setScheduleEnd)	Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	setTrialSettings(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.TrialSettings trialSettings)	Settings related to subscription trials.

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.Amendment build()

Finalize and obtain parameter instance from this builder.

setAmendmentEnd

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder setAmendmentEnd(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.AmendmentEnd amendmentEnd)

Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at amendment_start, and a restricted set of attributes is supported on the amendment.

setAmendmentStart

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder setAmendmentStart(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.AmendmentStart amendmentStart)

Required. Details to identify the earliest timestamp where the proposed change should take effect.

setBillingCycleAnchor

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder setBillingCycleAnchor(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingCycleAnchor billingCycleAnchor)

For point-in-time amendments (having no amendment_end), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the amendment_start timestamp.For time-span based amendments (having both amendment_start and amendment_end), the only value valid is automatic, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.

addBillingSchedulesAction

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder addBillingSchedulesAction(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingSchedulesAction element)

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

addAllBillingSchedulesAction

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

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

addDiscountAction

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder addDiscountAction(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.DiscountAction element)

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

addAllDiscountAction

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

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

setEffectiveAt

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder setEffectiveAt(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.EffectiveAt effectiveAt)

Configures how the subscription schedule handles billing for phase transitions. Possible values are phase_start (default) or billing_period_start. phase_start bills based on the current state of the subscription, ignoring changes scheduled in future phases. billing_period_start bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.

putExtraParam

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

putAllExtraParam

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

addItemAction

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder addItemAction(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.ItemAction element)

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

addAllItemAction

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

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

addMetadataAction

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder addMetadataAction(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.MetadataAction element)

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

addAllMetadataAction

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

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

setProrationBehavior

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

Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when amendment_end is null.

setSetPauseCollection

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder setSetPauseCollection(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.SetPauseCollection setPauseCollection)

Defines how to pause collection for the underlying subscription throughout the duration of the amendment.

setSetScheduleEnd

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder setSetScheduleEnd(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.SetScheduleEnd setScheduleEnd)

Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.

setTrialSettings

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder setTrialSettings(InvoiceCreatePreviewParams.ScheduleDetails.Amendment.TrialSettings trialSettings)

Settings related to subscription trials.