Package com.stripe.param

Class QuoteCreateParams.Line

java.lang.Object

com.stripe.param.QuoteCreateParams.Line

Enclosing class:

QuoteCreateParams

public static class QuoteCreateParams.Line
extends Object

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 QuoteCreateParams.InvoiceSettings.extraParams for the field documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuoteCreateParams.Line.Action
static class	QuoteCreateParams.Line.AppliesTo
static enum	QuoteCreateParams.Line.BillingCycleAnchor	Configure how an opt-in following a paid trial is billed when using billing_behavior: prorate_up_front.
static class	QuoteCreateParams.Line.Builder
static class	QuoteCreateParams.Line.EndsAt
static enum	QuoteCreateParams.Line.ProrationBehavior
static class	QuoteCreateParams.Line.SetPauseCollection
static enum	QuoteCreateParams.Line.SetScheduleEnd
static class	QuoteCreateParams.Line.StartsAt
static class	QuoteCreateParams.Line.TrialSettings

Method Summary

Modifier and Type	Method	Description
static QuoteCreateParams.Line.Builder	builder()
List<QuoteCreateParams.Line.Action>	getActions()	An array of operations the quote line performs.
QuoteCreateParams.Line.AppliesTo	getAppliesTo()	Details to identify the subscription schedule the quote line applies to.
QuoteCreateParams.Line.BillingCycleAnchor	getBillingCycleAnchor()	For a point-in-time operation, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the starts_at timestamp.
QuoteCreateParams.Line.EndsAt	getEndsAt()	Details to identify the end of the time range modified by the proposed change.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
QuoteCreateParams.Line.ProrationBehavior	getProrationBehavior()	Changes to how Stripe handles prorations during the quote line's time span.
QuoteCreateParams.Line.SetPauseCollection	getSetPauseCollection()	Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
QuoteCreateParams.Line.SetScheduleEnd	getSetScheduleEnd()	Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
QuoteCreateParams.Line.StartsAt	getStartsAt()	Details to identify the earliest timestamp where the proposed change should take effect.
QuoteCreateParams.Line.TrialSettings	getTrialSettings()	Settings related to subscription trials.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static QuoteCreateParams.Line.Builder builder()

getActions

public List<QuoteCreateParams.Line.Action> getActions()

An array of operations the quote line performs.

getAppliesTo

public QuoteCreateParams.Line.AppliesTo getAppliesTo()

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

getBillingCycleAnchor

public QuoteCreateParams.Line.BillingCycleAnchor getBillingCycleAnchor()

For a point-in-time operation, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the starts_at timestamp.

getEndsAt

public QuoteCreateParams.Line.EndsAt getEndsAt()

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.

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.

getProrationBehavior

public QuoteCreateParams.Line.ProrationBehavior getProrationBehavior()

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.

getSetPauseCollection

public QuoteCreateParams.Line.SetPauseCollection getSetPauseCollection()

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

getSetScheduleEnd

public QuoteCreateParams.Line.SetScheduleEnd getSetScheduleEnd()

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

getStartsAt

public QuoteCreateParams.Line.StartsAt getStartsAt()

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

getTrialSettings

public QuoteCreateParams.Line.TrialSettings getTrialSettings()

Settings related to subscription trials.