Package com.stripe.param
Class QuoteCreateParams.SubscriptionDataOverride.Builder
java.lang.Object
com.stripe.param.QuoteCreateParams.SubscriptionDataOverride.Builder
- Enclosing class:
- QuoteCreateParams.SubscriptionDataOverride
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Finalize and obtain parameter instance from this builder.putAllExtraParam
(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putExtraParam
(String key, Object value) Add a key/value pair to `extraParams` map.Required. Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.Configures when the subscription schedule generates prorations for phase transitions.Describes the period to bill for upon accepting the quote.setCustomer
(String customer) The customer the Subscription Data override applies to.setDescription
(String description) The subscription's description, meant to be displayable to the customer.Behavior of the subscription schedule and underlying subscription when it ends.setProrationBehavior
(QuoteCreateParams.SubscriptionDataOverride.ProrationBehavior prorationBehavior) Determines how to handle prorations.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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 areprorate_on_next_phase
orprorate_up_front
with the default beingprorate_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
The customer the Subscription Data override applies to. This is only relevant whenapplies_to.type=new_reference
. -
setDescription
The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. -
setEndBehavior
public QuoteCreateParams.SubscriptionDataOverride.Builder setEndBehavior(QuoteCreateParams.SubscriptionDataOverride.EndBehavior endBehavior) Behavior of the subscription schedule and underlying subscription when it ends. -
putExtraParam
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. SeeQuoteCreateParams.SubscriptionDataOverride.extraParams
for the field documentation. -
putAllExtraParam
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. SeeQuoteCreateParams.SubscriptionDataOverride.extraParams
for the field documentation. -
setProrationBehavior
public QuoteCreateParams.SubscriptionDataOverride.Builder setProrationBehavior(QuoteCreateParams.SubscriptionDataOverride.ProrationBehavior prorationBehavior) Determines how to handle prorations. When creating a subscription, valid values arecreate_prorations
ornone
.When updating a subscription, valid values are
create_prorations
,none
, oralways_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, passalways_invoice
.Prorations can be disabled by passing
none
.
-