Package com.stripe.param

Class InvoiceCreatePreviewParams.ScheduleDetails.Amendment

java.lang.Object

com.stripe.param.InvoiceCreatePreviewParams.ScheduleDetails.Amendment

Enclosing class:

InvoiceCreatePreviewParams.ScheduleDetails

public static class InvoiceCreatePreviewParams.ScheduleDetails.Amendment
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.AmendmentEnd
static class	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.AmendmentStart
static enum	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingCycleAnchor	Configure how an opt-in following a paid trial is billed when using billing_behavior: prorate_up_front.
static class	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingSchedulesAction
static class	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder
static class	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.DiscountAction
static enum	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.EffectiveAt
static class	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.ItemAction
static class	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.MetadataAction
static enum	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.ProrationBehavior
static class	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.SetPauseCollection
static enum	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.SetScheduleEnd
static class	InvoiceCreatePreviewParams.ScheduleDetails.Amendment.TrialSettings

Method Summary

Modifier and Type	Method	Description
static InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.AmendmentEnd	getAmendmentEnd()	Details to identify the end of the time range modified by the proposed change.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.AmendmentStart	getAmendmentStart()	Required. Details to identify the earliest timestamp where the proposed change should take effect.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingCycleAnchor	getBillingCycleAnchor()	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.
List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingSchedulesAction>	getBillingSchedulesActions()	Actions to apply to the billing schedules.
List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.DiscountAction>	getDiscountActions()	Changes to the coupons being redeemed or discounts being applied during the amendment time span.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.EffectiveAt	getEffectiveAt()	Configures how the subscription schedule handles billing for phase transitions.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.ItemAction>	getItemActions()	Changes to the subscription items during the amendment time span.
List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.MetadataAction>	getMetadataActions()	Instructions for how to modify phase metadata.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.ProrationBehavior	getProrationBehavior()	Changes to how Stripe handles prorations during the amendment time span.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.SetPauseCollection	getSetPauseCollection()	Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.SetScheduleEnd	getSetScheduleEnd()	Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
InvoiceCreatePreviewParams.ScheduleDetails.Amendment.TrialSettings	getTrialSettings()	Settings related to subscription trials.
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static InvoiceCreatePreviewParams.ScheduleDetails.Amendment.Builder builder()

getAmendmentEnd

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.AmendmentEnd getAmendmentEnd()

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.

getAmendmentStart

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.AmendmentStart getAmendmentStart()

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

getBillingCycleAnchor

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingCycleAnchor getBillingCycleAnchor()

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.

getBillingSchedulesActions

public List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.BillingSchedulesAction> getBillingSchedulesActions()

Actions to apply to the billing schedules.

getDiscountActions

public List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.DiscountAction> getDiscountActions()

Changes to the coupons being redeemed or discounts being applied during the amendment time span.

getEffectiveAt

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.EffectiveAt getEffectiveAt()

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.

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.

getItemActions

public List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.ItemAction> getItemActions()

Changes to the subscription items during the amendment time span.

getMetadataActions

public List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment.MetadataAction> getMetadataActions()

Instructions for how to modify phase metadata.

getProrationBehavior

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.ProrationBehavior getProrationBehavior()

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.

getSetPauseCollection

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.SetPauseCollection getSetPauseCollection()

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

getSetScheduleEnd

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.SetScheduleEnd getSetScheduleEnd()

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

getTrialSettings

public InvoiceCreatePreviewParams.ScheduleDetails.Amendment.TrialSettings getTrialSettings()

Settings related to subscription trials.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object