Package com.stripe.param

Class QuoteUpdateParams.Line.Builder

java.lang.Object

com.stripe.param.QuoteUpdateParams.Line.Builder

Enclosing class:

QuoteUpdateParams.Line

public static class QuoteUpdateParams.Line.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QuoteUpdateParams.Line.Builder	addAction(QuoteUpdateParams.Line.Action element)	Add an element to `actions` list.
QuoteUpdateParams.Line.Builder	addAllAction(List<QuoteUpdateParams.Line.Action> elements)	Add all elements to `actions` list.
QuoteUpdateParams.Line	build()	Finalize and obtain parameter instance from this builder.
QuoteUpdateParams.Line.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
QuoteUpdateParams.Line.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
QuoteUpdateParams.Line.Builder	setAppliesTo(QuoteUpdateParams.Line.AppliesTo appliesTo)	Details to identify the subscription schedule the quote line applies to.
QuoteUpdateParams.Line.Builder	setBillingCycleAnchor(QuoteUpdateParams.Line.BillingCycleAnchor billingCycleAnchor)	For point-in-time quote lines (having no ends_at timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line starts_at timestamp.For time-span based quote lines (having both starts_at and ends_at), the only valid value is automatic, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
QuoteUpdateParams.Line.Builder	setCancelSubscriptionSchedule(QuoteUpdateParams.Line.CancelSubscriptionSchedule cancelSubscriptionSchedule)	A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp.
QuoteUpdateParams.Line.Builder	setEndsAt(QuoteUpdateParams.Line.EndsAt endsAt)	Details to identify the end of the time range modified by the proposed change.
QuoteUpdateParams.Line.Builder	setId(EmptyParam id)	The ID of an existing line on the quote.
QuoteUpdateParams.Line.Builder	setId(String id)	The ID of an existing line on the quote.
QuoteUpdateParams.Line.Builder	setProrationBehavior(QuoteUpdateParams.Line.ProrationBehavior prorationBehavior)	Changes to how Stripe handles prorations during the quote line's time span.
QuoteUpdateParams.Line.Builder	setSetPauseCollection(QuoteUpdateParams.Line.SetPauseCollection setPauseCollection)	Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
QuoteUpdateParams.Line.Builder	setSetScheduleEnd(QuoteUpdateParams.Line.SetScheduleEnd setScheduleEnd)	Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
QuoteUpdateParams.Line.Builder	setStartsAt(QuoteUpdateParams.Line.StartsAt startsAt)	Details to identify the earliest timestamp where the proposed change should take effect.
QuoteUpdateParams.Line.Builder	setTrialSettings(QuoteUpdateParams.Line.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 QuoteUpdateParams.Line build()

Finalize and obtain parameter instance from this builder.

addAction

public QuoteUpdateParams.Line.Builder addAction(QuoteUpdateParams.Line.Action element)

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

addAllAction

public QuoteUpdateParams.Line.Builder addAllAction(List<QuoteUpdateParams.Line.Action> elements)

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

setAppliesTo

public QuoteUpdateParams.Line.Builder setAppliesTo(QuoteUpdateParams.Line.AppliesTo appliesTo)

Details to identify the subscription schedule the quote line applies to.

setBillingCycleAnchor

public QuoteUpdateParams.Line.Builder setBillingCycleAnchor(QuoteUpdateParams.Line.BillingCycleAnchor billingCycleAnchor)

For point-in-time quote lines (having no ends_at timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line starts_at timestamp.For time-span based quote lines (having both starts_at and ends_at), the only valid value is automatic, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.

setCancelSubscriptionSchedule

public QuoteUpdateParams.Line.Builder setCancelSubscriptionSchedule(QuoteUpdateParams.Line.CancelSubscriptionSchedule cancelSubscriptionSchedule)

A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with quote_acceptance_date for starts_at. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.

setEndsAt

public QuoteUpdateParams.Line.Builder setEndsAt(QuoteUpdateParams.Line.EndsAt endsAt)

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

putExtraParam

public QuoteUpdateParams.Line.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 QuoteUpdateParams.Line.extraParams for the field documentation.

putAllExtraParam

public QuoteUpdateParams.Line.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 QuoteUpdateParams.Line.extraParams for the field documentation.

setId

public QuoteUpdateParams.Line.Builder setId(String id)

The ID of an existing line on the quote.

setId

public QuoteUpdateParams.Line.Builder setId(EmptyParam id)

The ID of an existing line on the quote.

setProrationBehavior

public QuoteUpdateParams.Line.Builder setProrationBehavior(QuoteUpdateParams.Line.ProrationBehavior prorationBehavior)

Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.

setSetPauseCollection

public QuoteUpdateParams.Line.Builder setSetPauseCollection(QuoteUpdateParams.Line.SetPauseCollection setPauseCollection)

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

setSetScheduleEnd

public QuoteUpdateParams.Line.Builder setSetScheduleEnd(QuoteUpdateParams.Line.SetScheduleEnd setScheduleEnd)

Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.

setStartsAt

public QuoteUpdateParams.Line.Builder setStartsAt(QuoteUpdateParams.Line.StartsAt startsAt)

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

setTrialSettings

public QuoteUpdateParams.Line.Builder setTrialSettings(QuoteUpdateParams.Line.TrialSettings trialSettings)

Settings related to subscription trials.