Class SubscriptionItemCreateParams.Builder
- java.lang.Object
-
- com.stripe.param.SubscriptionItemCreateParams.Builder
-
- Enclosing class:
- SubscriptionItemCreateParams
public static class SubscriptionItemCreateParams.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubscriptionItemCreateParams.Builder
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.SubscriptionItemCreateParams.Builder
addAllTaxRate(java.util.List<java.lang.String> elements)
Add all elements to `taxRates` list.SubscriptionItemCreateParams.Builder
addExpand(java.lang.String element)
Add an element to `expand` list.SubscriptionItemCreateParams.Builder
addTaxRate(java.lang.String element)
Add an element to `taxRates` list.SubscriptionItemCreateParams
build()
Finalize and obtain parameter instance from this builder.SubscriptionItemCreateParams.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.SubscriptionItemCreateParams.Builder
putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
Add all map key/value pairs to `metadata` map.SubscriptionItemCreateParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.SubscriptionItemCreateParams.Builder
putMetadata(java.lang.String key, java.lang.String value)
Add a key/value pair to `metadata` map.SubscriptionItemCreateParams.Builder
setBillingThresholds(EmptyParam billingThresholds)
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.SubscriptionItemCreateParams.Builder
setBillingThresholds(SubscriptionItemCreateParams.BillingThresholds billingThresholds)
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.SubscriptionItemCreateParams.Builder
setPaymentBehavior(SubscriptionItemCreateParams.PaymentBehavior paymentBehavior)
Useallow_incomplete
to transition the subscription tostatus=past_due
if a payment is required but cannot be paid.SubscriptionItemCreateParams.Builder
setPlan(java.lang.String plan)
The identifier of the plan to add to the subscription.SubscriptionItemCreateParams.Builder
setPrice(java.lang.String price)
The ID of the price object.SubscriptionItemCreateParams.Builder
setPriceData(SubscriptionItemCreateParams.PriceData priceData)
Data used to generate a new Price object inline.SubscriptionItemCreateParams.Builder
setProrationBehavior(SubscriptionItemCreateParams.ProrationBehavior prorationBehavior)
Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resettingbilling_cycle_anchor=now
, or starting a trial), or if an item'squantity
changes.SubscriptionItemCreateParams.Builder
setProrationDate(java.lang.Long prorationDate)
If set, the proration will be calculated as though the subscription was updated at the given time.SubscriptionItemCreateParams.Builder
setQuantity(java.lang.Long quantity)
The quantity you'd like to apply to the subscription item you're creating.SubscriptionItemCreateParams.Builder
setSubscription(java.lang.String subscription)
The identifier of the subscription to modify.SubscriptionItemCreateParams.Builder
setTaxRates(EmptyParam taxRates)
A list of Tax Rate ids.SubscriptionItemCreateParams.Builder
setTaxRates(java.util.List<java.lang.String> taxRates)
A list of Tax Rate ids.
-
-
-
Method Detail
-
build
public SubscriptionItemCreateParams build()
Finalize and obtain parameter instance from this builder.
-
setBillingThresholds
public SubscriptionItemCreateParams.Builder setBillingThresholds(SubscriptionItemCreateParams.BillingThresholds billingThresholds)
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
-
setBillingThresholds
public SubscriptionItemCreateParams.Builder setBillingThresholds(EmptyParam billingThresholds)
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
-
addExpand
public SubscriptionItemCreateParams.Builder addExpand(java.lang.String element)
Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSubscriptionItemCreateParams.expand
for the field documentation.
-
addAllExpand
public SubscriptionItemCreateParams.Builder addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSubscriptionItemCreateParams.expand
for the field documentation.
-
putExtraParam
public SubscriptionItemCreateParams.Builder putExtraParam(java.lang.String key, java.lang.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. SeeSubscriptionItemCreateParams.extraParams
for the field documentation.
-
putAllExtraParam
public SubscriptionItemCreateParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.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. SeeSubscriptionItemCreateParams.extraParams
for the field documentation.
-
putMetadata
public SubscriptionItemCreateParams.Builder putMetadata(java.lang.String key, java.lang.String value)
Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSubscriptionItemCreateParams.metadata
for the field documentation.
-
putAllMetadata
public SubscriptionItemCreateParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSubscriptionItemCreateParams.metadata
for the field documentation.
-
setPaymentBehavior
public SubscriptionItemCreateParams.Builder setPaymentBehavior(SubscriptionItemCreateParams.PaymentBehavior paymentBehavior)
Useallow_incomplete
to transition the subscription tostatus=past_due
if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.Use
default_incomplete
to transition the subscription tostatus=past_due
when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.Use
pending_if_incomplete
to update the subscription using pending updates. When you usepending_if_incomplete
you can only pass the parameters supported by pending updates.Use
error_if_incomplete
if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.
-
setPlan
public SubscriptionItemCreateParams.Builder setPlan(java.lang.String plan)
The identifier of the plan to add to the subscription.
-
setPrice
public SubscriptionItemCreateParams.Builder setPrice(java.lang.String price)
The ID of the price object.
-
setPriceData
public SubscriptionItemCreateParams.Builder setPriceData(SubscriptionItemCreateParams.PriceData priceData)
Data used to generate a new Price object inline.
-
setProrationBehavior
public SubscriptionItemCreateParams.Builder setProrationBehavior(SubscriptionItemCreateParams.ProrationBehavior prorationBehavior)
Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resettingbilling_cycle_anchor=now
, or starting a trial), or if an item'squantity
changes. Valid values arecreate_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
.
-
setProrationDate
public SubscriptionItemCreateParams.Builder setProrationDate(java.lang.Long prorationDate)
If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
-
setQuantity
public SubscriptionItemCreateParams.Builder setQuantity(java.lang.Long quantity)
The quantity you'd like to apply to the subscription item you're creating.
-
setSubscription
public SubscriptionItemCreateParams.Builder setSubscription(java.lang.String subscription)
The identifier of the subscription to modify.
-
addTaxRate
public SubscriptionItemCreateParams.Builder addTaxRate(java.lang.String element)
Add an element to `taxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSubscriptionItemCreateParams.taxRates
for the field documentation.
-
addAllTaxRate
public SubscriptionItemCreateParams.Builder addAllTaxRate(java.util.List<java.lang.String> elements)
Add all elements to `taxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSubscriptionItemCreateParams.taxRates
for the field documentation.
-
setTaxRates
public SubscriptionItemCreateParams.Builder setTaxRates(EmptyParam taxRates)
A list of Tax Rate ids. These Tax Rates will override thedefault_tax_rates
on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
-
setTaxRates
public SubscriptionItemCreateParams.Builder setTaxRates(java.util.List<java.lang.String> taxRates)
A list of Tax Rate ids. These Tax Rates will override thedefault_tax_rates
on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
-
-