Package com.stripe.param

Class QuoteUpdateParams.SubscriptionDataOverride.Builder

java.lang.Object

com.stripe.param.QuoteUpdateParams.SubscriptionDataOverride.Builder

Enclosing class:

QuoteUpdateParams.SubscriptionDataOverride

public static class QuoteUpdateParams.SubscriptionDataOverride.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QuoteUpdateParams.SubscriptionDataOverride	build()	Finalize and obtain parameter instance from this builder.
QuoteUpdateParams.SubscriptionDataOverride.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
QuoteUpdateParams.SubscriptionDataOverride.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
QuoteUpdateParams.SubscriptionDataOverride.Builder	setAppliesTo(QuoteUpdateParams.SubscriptionDataOverride.AppliesTo appliesTo)	Required. Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
QuoteUpdateParams.SubscriptionDataOverride.Builder	setBillingBehavior(QuoteUpdateParams.SubscriptionDataOverride.BillingBehavior billingBehavior)	Configures when the subscription schedule generates prorations for phase transitions.
QuoteUpdateParams.SubscriptionDataOverride.Builder	setBillOnAcceptance(EmptyParam billOnAcceptance)	Describes the period to bill for upon accepting the quote.
QuoteUpdateParams.SubscriptionDataOverride.Builder	setBillOnAcceptance(QuoteUpdateParams.SubscriptionDataOverride.BillOnAcceptance billOnAcceptance)	Describes the period to bill for upon accepting the quote.
QuoteUpdateParams.SubscriptionDataOverride.Builder	setCustomer(EmptyParam customer)	The customer the Subscription Data override applies to.
QuoteUpdateParams.SubscriptionDataOverride.Builder	setCustomer(String customer)	The customer the Subscription Data override applies to.
QuoteUpdateParams.SubscriptionDataOverride.Builder	setDescription(EmptyParam description)	The subscription's description, meant to be displayable to the customer.
QuoteUpdateParams.SubscriptionDataOverride.Builder	setDescription(String description)	The subscription's description, meant to be displayable to the customer.
QuoteUpdateParams.SubscriptionDataOverride.Builder	setEndBehavior(QuoteUpdateParams.SubscriptionDataOverride.EndBehavior endBehavior)	Behavior of the subscription schedule and underlying subscription when it ends.
QuoteUpdateParams.SubscriptionDataOverride.Builder	setProrationBehavior(QuoteUpdateParams.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 QuoteUpdateParams.SubscriptionDataOverride build()

Finalize and obtain parameter instance from this builder.

setAppliesTo

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

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

setBillOnAcceptance

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

Describes the period to bill for upon accepting the quote.

setBillOnAcceptance

public QuoteUpdateParams.SubscriptionDataOverride.Builder setBillOnAcceptance(EmptyParam billOnAcceptance)

Describes the period to bill for upon accepting the quote.

setBillingBehavior

public QuoteUpdateParams.SubscriptionDataOverride.Builder setBillingBehavior(QuoteUpdateParams.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.

setCustomer

public QuoteUpdateParams.SubscriptionDataOverride.Builder setCustomer(String customer)

The customer the Subscription Data override applies to.

setCustomer

public QuoteUpdateParams.SubscriptionDataOverride.Builder setCustomer(EmptyParam customer)

The customer the Subscription Data override applies to.

setDescription

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

setDescription

public QuoteUpdateParams.SubscriptionDataOverride.Builder setDescription(EmptyParam 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 QuoteUpdateParams.SubscriptionDataOverride.Builder setEndBehavior(QuoteUpdateParams.SubscriptionDataOverride.EndBehavior endBehavior)

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

putExtraParam

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

putAllExtraParam

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

setProrationBehavior

public QuoteUpdateParams.SubscriptionDataOverride.Builder setProrationBehavior(QuoteUpdateParams.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.