Package com.stripe.param

Class QuoteCreateParams.SubscriptionDataOverride

java.lang.Object

com.stripe.param.QuoteCreateParams.SubscriptionDataOverride

Enclosing class:

QuoteCreateParams

public static class QuoteCreateParams.SubscriptionDataOverride
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuoteCreateParams.SubscriptionDataOverride.AppliesTo
static enum	QuoteCreateParams.SubscriptionDataOverride.BillingBehavior	The position of the previous quote line in the lines array after which this line should begin.
static class	QuoteCreateParams.SubscriptionDataOverride.BillOnAcceptance
static class	QuoteCreateParams.SubscriptionDataOverride.Builder
static enum	QuoteCreateParams.SubscriptionDataOverride.EndBehavior
static enum	QuoteCreateParams.SubscriptionDataOverride.ProrationBehavior

Method Summary

Modifier and Type	Method	Description
static QuoteCreateParams.SubscriptionDataOverride.Builder	builder()
QuoteCreateParams.SubscriptionDataOverride.AppliesTo	getAppliesTo()	Required. Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
QuoteCreateParams.SubscriptionDataOverride.BillingBehavior	getBillingBehavior()	Configures when the subscription schedule generates prorations for phase transitions.
QuoteCreateParams.SubscriptionDataOverride.BillOnAcceptance	getBillOnAcceptance()	Describes the period to bill for upon accepting the quote.
String	getCustomer()	The customer the Subscription Data override applies to.
String	getDescription()	The subscription's description, meant to be displayable to the customer.
QuoteCreateParams.SubscriptionDataOverride.EndBehavior	getEndBehavior()	Behavior of the subscription schedule and underlying subscription when it ends.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
QuoteCreateParams.SubscriptionDataOverride.ProrationBehavior	getProrationBehavior()	Determines how to handle prorations.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static QuoteCreateParams.SubscriptionDataOverride.Builder builder()

getAppliesTo

public QuoteCreateParams.SubscriptionDataOverride.AppliesTo getAppliesTo()

Required. Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.

getBillOnAcceptance

public QuoteCreateParams.SubscriptionDataOverride.BillOnAcceptance getBillOnAcceptance()

Describes the period to bill for upon accepting the quote.

getBillingBehavior

public QuoteCreateParams.SubscriptionDataOverride.BillingBehavior getBillingBehavior()

Configures when the subscription schedule generates prorations for phase transitions. Possible values are prorate_on_next_phase or prorate_up_front with the default being prorate_on_next_phase. prorate_on_next_phase will apply phase changes and generate prorations at transition time.prorate_up_front will bill for all phases within the current billing cycle up front.

getCustomer

public String getCustomer()

The customer the Subscription Data override applies to. This is only relevant when applies_to.type=new_reference.

getDescription

public String getDescription()

The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.

getEndBehavior

public QuoteCreateParams.SubscriptionDataOverride.EndBehavior getEndBehavior()

Behavior of the subscription schedule and underlying subscription when it ends.

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.SubscriptionDataOverride.ProrationBehavior getProrationBehavior()

Determines how to handle prorations. When creating a subscription, valid values are create_prorations or none.

When updating a subscription, valid values are create_prorations, none, or always_invoice.

Passing create_prorations will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass always_invoice.

Prorations can be disabled by passing none.