Package com.stripe.param

Class SubscriptionScheduleAmendParams.Amendment

java.lang.Object

com.stripe.param.SubscriptionScheduleAmendParams.Amendment

Enclosing class:

SubscriptionScheduleAmendParams

public static class SubscriptionScheduleAmendParams.Amendment
extends Object

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SubscriptionScheduleAmendParams.Amendment.Builder	builder()
SubscriptionScheduleAmendParams.Amendment.AmendmentEnd	getAmendmentEnd()	Details to identify the end of the time range modified by the proposed change.
SubscriptionScheduleAmendParams.Amendment.AmendmentStart	getAmendmentStart()	Required. Details to identify the earliest timestamp where the proposed change should take effect.
SubscriptionScheduleAmendParams.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<SubscriptionScheduleAmendParams.Amendment.DiscountAction>	getDiscountActions()	Changes to the coupons being redeemed or discounts being applied during the amendment time span.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
List<SubscriptionScheduleAmendParams.Amendment.ItemAction>	getItemActions()	Changes to the subscription items during the amendment time span.
List<SubscriptionScheduleAmendParams.Amendment.MetadataAction>	getMetadataActions()	Instructions for how to modify phase metadata.
SubscriptionScheduleAmendParams.Amendment.ProrationBehavior	getProrationBehavior()	Changes to how Stripe handles prorations during the amendment time span.
SubscriptionScheduleAmendParams.Amendment.SetPauseCollection	getSetPauseCollection()	Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
SubscriptionScheduleAmendParams.Amendment.SetScheduleEnd	getSetScheduleEnd()	Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
SubscriptionScheduleAmendParams.Amendment.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 SubscriptionScheduleAmendParams.Amendment.Builder builder()

getAmendmentEnd

public SubscriptionScheduleAmendParams.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 SubscriptionScheduleAmendParams.Amendment.AmendmentStart getAmendmentStart()

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

getBillingCycleAnchor

public SubscriptionScheduleAmendParams.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.

getDiscountActions

public List<SubscriptionScheduleAmendParams.Amendment.DiscountAction> getDiscountActions()

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

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<SubscriptionScheduleAmendParams.Amendment.ItemAction> getItemActions()

Changes to the subscription items during the amendment time span.

getMetadataActions

public List<SubscriptionScheduleAmendParams.Amendment.MetadataAction> getMetadataActions()

Instructions for how to modify phase metadata.

getProrationBehavior

public SubscriptionScheduleAmendParams.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 SubscriptionScheduleAmendParams.Amendment.SetPauseCollection getSetPauseCollection()

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

getSetScheduleEnd

public SubscriptionScheduleAmendParams.Amendment.SetScheduleEnd getSetScheduleEnd()

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

getTrialSettings

public SubscriptionScheduleAmendParams.Amendment.TrialSettings getTrialSettings()

Settings related to subscription trials.