Package com.stripe.param
Class QuoteUpdateParams.SubscriptionDataOverride
java.lang.Object
com.stripe.param.QuoteUpdateParams.SubscriptionDataOverride
- Enclosing class:
- QuoteUpdateParams
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
The position of the previous quote line in thelines
array after which this line should begin.static class
static class
static enum
static enum
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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.The customer the Subscription Data override applies to.The subscription's description, meant to be displayable to the customer.Behavior of the subscription schedule and underlying subscription when it ends.Map of extra parameters for custom features not available in this client library.Determines how to handle prorations.
-
Method Details
-
builder
-
getAppliesTo
Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule. -
getBillOnAcceptance
Describes the period to bill for upon accepting the quote. -
getBillingBehavior
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. -
getCustomer
The customer the Subscription Data override applies to. -
getDescription
The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. -
getEndBehavior
Behavior of the subscription schedule and underlying subscription when it ends. -
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
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
.
-