Package com.stripe.param

Class SubscriptionItemCreateParams.Builder

java.lang.Object

com.stripe.param.SubscriptionItemCreateParams.Builder

Enclosing class:

SubscriptionItemCreateParams

public static class SubscriptionItemCreateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SubscriptionItemCreateParams.Builder	addAllDiscount(List<SubscriptionItemCreateParams.Discount> elements)	Add all elements to `discounts` list.
SubscriptionItemCreateParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
SubscriptionItemCreateParams.Builder	addAllTaxRate(List<String> elements)	Add all elements to `taxRates` list.
SubscriptionItemCreateParams.Builder	addDiscount(SubscriptionItemCreateParams.Discount element)	Add an element to `discounts` list.
SubscriptionItemCreateParams.Builder	addExpand(String element)	Add an element to `expand` list.
SubscriptionItemCreateParams.Builder	addTaxRate(String element)	Add an element to `taxRates` list.
SubscriptionItemCreateParams	build()	Finalize and obtain parameter instance from this builder.
SubscriptionItemCreateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
SubscriptionItemCreateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
SubscriptionItemCreateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
SubscriptionItemCreateParams.Builder	putMetadata(String key, 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	setCurrentTrial(SubscriptionItemCreateParams.CurrentTrial currentTrial)	The trial offer to apply to this subscription item.
SubscriptionItemCreateParams.Builder	setDiscounts(EmptyParam discounts)	The coupons to redeem into discounts for the subscription item.
SubscriptionItemCreateParams.Builder	setDiscounts(List<SubscriptionItemCreateParams.Discount> discounts)	The coupons to redeem into discounts for the subscription item.
SubscriptionItemCreateParams.Builder	setPaymentBehavior(SubscriptionItemCreateParams.PaymentBehavior paymentBehavior)	Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid.
SubscriptionItemCreateParams.Builder	setPlan(String plan)	The identifier of the plan to add to the subscription.
SubscriptionItemCreateParams.Builder	setPrice(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, resetting billing_cycle_anchor=now, or starting a trial), or if an item's quantity changes.
SubscriptionItemCreateParams.Builder	setProrationDate(Long prorationDate)	If set, the proration will be calculated as though the subscription was updated at the given time.
SubscriptionItemCreateParams.Builder	setQuantity(Long quantity)	The quantity you'd like to apply to the subscription item you're creating.
SubscriptionItemCreateParams.Builder	setSubscription(String subscription)	Required. The identifier of the subscription to modify.
SubscriptionItemCreateParams.Builder	setTaxRates(EmptyParam taxRates)	A list of Tax Rate ids.
SubscriptionItemCreateParams.Builder	setTaxRates(List<String> taxRates)	A list of Tax Rate ids.
SubscriptionItemCreateParams.Builder	setTrial(SubscriptionItemCreateParams.Trial trial)	Options that configure the trial on the subscription item.

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 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. 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. Pass an empty string to remove previously-defined thresholds.

setCurrentTrial

public SubscriptionItemCreateParams.Builder setCurrentTrial(SubscriptionItemCreateParams.CurrentTrial currentTrial)

The trial offer to apply to this subscription item.

addDiscount

public SubscriptionItemCreateParams.Builder addDiscount(SubscriptionItemCreateParams.Discount element)

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

addAllDiscount

public SubscriptionItemCreateParams.Builder addAllDiscount(List<SubscriptionItemCreateParams.Discount> elements)

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

setDiscounts

public SubscriptionItemCreateParams.Builder setDiscounts(EmptyParam discounts)

The coupons to redeem into discounts for the subscription item.

setDiscounts

public SubscriptionItemCreateParams.Builder setDiscounts(List<SubscriptionItemCreateParams.Discount> discounts)

The coupons to redeem into discounts for the subscription item.

addExpand

public SubscriptionItemCreateParams.Builder addExpand(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. See SubscriptionItemCreateParams.expand for the field documentation.

addAllExpand

public SubscriptionItemCreateParams.Builder addAllExpand(List<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. See SubscriptionItemCreateParams.expand for the field documentation.

putExtraParam

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

putAllExtraParam

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

putMetadata

public SubscriptionItemCreateParams.Builder putMetadata(String key,
 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. See SubscriptionItemCreateParams.metadata for the field documentation.

putAllMetadata

public SubscriptionItemCreateParams.Builder putAllMetadata(Map<String,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. See SubscriptionItemCreateParams.metadata for the field documentation.

setPaymentBehavior

public SubscriptionItemCreateParams.Builder setPaymentBehavior(SubscriptionItemCreateParams.PaymentBehavior paymentBehavior)

Use allow_incomplete to transition the subscription to status=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 to status=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 use pending_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(String plan)

The identifier of the plan to add to the subscription.

setPrice

public SubscriptionItemCreateParams.Builder setPrice(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, resetting billing_cycle_anchor=now, or starting a trial), or if an item's quantity changes. The default value is create_prorations.

setProrationDate

public SubscriptionItemCreateParams.Builder setProrationDate(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(Long quantity)

The quantity you'd like to apply to the subscription item you're creating.

setSubscription

public SubscriptionItemCreateParams.Builder setSubscription(String subscription)

Required. The identifier of the subscription to modify.

addTaxRate

public SubscriptionItemCreateParams.Builder addTaxRate(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. See SubscriptionItemCreateParams.taxRates for the field documentation.

addAllTaxRate

public SubscriptionItemCreateParams.Builder addAllTaxRate(List<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. See SubscriptionItemCreateParams.taxRates for the field documentation.

setTaxRates

public SubscriptionItemCreateParams.Builder setTaxRates(EmptyParam taxRates)

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

setTaxRates

public SubscriptionItemCreateParams.Builder setTaxRates(List<String> taxRates)

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

setTrial

public SubscriptionItemCreateParams.Builder setTrial(SubscriptionItemCreateParams.Trial trial)

Options that configure the trial on the subscription item.