Package com.stripe.param

Class QuoteCreateParams.SubscriptionDataOverride.Builder

java.lang.Object

com.stripe.param.QuoteCreateParams.SubscriptionDataOverride.Builder

Enclosing class:

QuoteCreateParams.SubscriptionDataOverride

public static class QuoteCreateParams.SubscriptionDataOverride.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QuoteCreateParams.SubscriptionDataOverride.Builder	addAllBillingSchedule(List<QuoteCreateParams.SubscriptionDataOverride.BillingSchedule> elements)	Add all elements to `billingSchedules` list.
QuoteCreateParams.SubscriptionDataOverride.Builder	addBillingSchedule(QuoteCreateParams.SubscriptionDataOverride.BillingSchedule element)	Add an element to `billingSchedules` list.
QuoteCreateParams.SubscriptionDataOverride	build()	Finalize and obtain parameter instance from this builder.
QuoteCreateParams.SubscriptionDataOverride.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
QuoteCreateParams.SubscriptionDataOverride.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
QuoteCreateParams.SubscriptionDataOverride.Builder	setAppliesTo(QuoteCreateParams.SubscriptionDataOverride.AppliesTo appliesTo)	Required. Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
QuoteCreateParams.SubscriptionDataOverride.Builder	setBillingBehavior(QuoteCreateParams.SubscriptionDataOverride.BillingBehavior billingBehavior)	Configures when the subscription schedule generates prorations for phase transitions.
QuoteCreateParams.SubscriptionDataOverride.Builder	setBillOnAcceptance(QuoteCreateParams.SubscriptionDataOverride.BillOnAcceptance billOnAcceptance)	Describes the period to bill for upon accepting the quote.
QuoteCreateParams.SubscriptionDataOverride.Builder	setCustomer(String customer)	The customer the Subscription Data override applies to.
QuoteCreateParams.SubscriptionDataOverride.Builder	setDescription(String description)	The subscription's description, meant to be displayable to the customer.
QuoteCreateParams.SubscriptionDataOverride.Builder	setEndBehavior(QuoteCreateParams.SubscriptionDataOverride.EndBehavior endBehavior)	Behavior of the subscription schedule and underlying subscription when it ends.
QuoteCreateParams.SubscriptionDataOverride.Builder	setPhaseEffectiveAt(QuoteCreateParams.SubscriptionDataOverride.PhaseEffectiveAt phaseEffectiveAt)	Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
QuoteCreateParams.SubscriptionDataOverride.Builder	setProrationBehavior(QuoteCreateParams.SubscriptionDataOverride.ProrationBehavior prorationBehavior)	Determines how to handle prorations.

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 QuoteCreateParams.SubscriptionDataOverride build()

Finalize and obtain parameter instance from this builder.

setAppliesTo

public QuoteCreateParams.SubscriptionDataOverride.Builder setAppliesTo(QuoteCreateParams.SubscriptionDataOverride.AppliesTo appliesTo)

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

setBillOnAcceptance

public QuoteCreateParams.SubscriptionDataOverride.Builder setBillOnAcceptance(QuoteCreateParams.SubscriptionDataOverride.BillOnAcceptance billOnAcceptance)

Describes the period to bill for upon accepting the quote.

setBillingBehavior

public QuoteCreateParams.SubscriptionDataOverride.Builder setBillingBehavior(QuoteCreateParams.SubscriptionDataOverride.BillingBehavior billingBehavior)

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.

addBillingSchedule

public QuoteCreateParams.SubscriptionDataOverride.Builder addBillingSchedule(QuoteCreateParams.SubscriptionDataOverride.BillingSchedule element)

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

addAllBillingSchedule

public QuoteCreateParams.SubscriptionDataOverride.Builder addAllBillingSchedule(List<QuoteCreateParams.SubscriptionDataOverride.BillingSchedule> elements)

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

setCustomer

public QuoteCreateParams.SubscriptionDataOverride.Builder setCustomer(String customer)

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

setDescription

public QuoteCreateParams.SubscriptionDataOverride.Builder setDescription(String description)

The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

setEndBehavior

public QuoteCreateParams.SubscriptionDataOverride.Builder setEndBehavior(QuoteCreateParams.SubscriptionDataOverride.EndBehavior endBehavior)

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

putExtraParam

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

putAllExtraParam

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

setPhaseEffectiveAt

public QuoteCreateParams.SubscriptionDataOverride.Builder setPhaseEffectiveAt(QuoteCreateParams.SubscriptionDataOverride.PhaseEffectiveAt phaseEffectiveAt)

Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. 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.

setProrationBehavior

public QuoteCreateParams.SubscriptionDataOverride.Builder setProrationBehavior(QuoteCreateParams.SubscriptionDataOverride.ProrationBehavior prorationBehavior)

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.