Package com.stripe.param

Class SubscriptionItemUpdateParams.Builder

java.lang.Object

com.stripe.param.SubscriptionItemUpdateParams.Builder

Enclosing class:

SubscriptionItemUpdateParams

public static class SubscriptionItemUpdateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SubscriptionItemUpdateParams.Builder	addAllDiscount(List<SubscriptionItemUpdateParams.Discount> elements)	Add all elements to `discounts` list.
SubscriptionItemUpdateParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
SubscriptionItemUpdateParams.Builder	addAllTaxRate(List<String> elements)	Add all elements to `taxRates` list.
SubscriptionItemUpdateParams.Builder	addDiscount(SubscriptionItemUpdateParams.Discount element)	Add an element to `discounts` list.
SubscriptionItemUpdateParams.Builder	addExpand(String element)	Add an element to `expand` list.
SubscriptionItemUpdateParams.Builder	addTaxRate(String element)	Add an element to `taxRates` list.
SubscriptionItemUpdateParams	build()	Finalize and obtain parameter instance from this builder.
SubscriptionItemUpdateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
SubscriptionItemUpdateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
SubscriptionItemUpdateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
SubscriptionItemUpdateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
SubscriptionItemUpdateParams.Builder	setBillingThresholds(EmptyParam billingThresholds)	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
SubscriptionItemUpdateParams.Builder	setBillingThresholds(SubscriptionItemUpdateParams.BillingThresholds billingThresholds)	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
SubscriptionItemUpdateParams.Builder	setDiscounts(EmptyParam discounts)	The coupons to redeem into discounts for the subscription item.
SubscriptionItemUpdateParams.Builder	setDiscounts(List<SubscriptionItemUpdateParams.Discount> discounts)	The coupons to redeem into discounts for the subscription item.
SubscriptionItemUpdateParams.Builder	setMetadata(EmptyParam metadata)	Set of key-value pairs that you can attach to an object.
SubscriptionItemUpdateParams.Builder	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
SubscriptionItemUpdateParams.Builder	setOffSession(Boolean offSession)	Indicates if a customer is on or off-session while an invoice payment is attempted.
SubscriptionItemUpdateParams.Builder	setPaymentBehavior(SubscriptionItemUpdateParams.PaymentBehavior paymentBehavior)	Controls how Stripe handles payment when a subscription update requires payment and collection_method=charge_automatically.
SubscriptionItemUpdateParams.Builder	setPlan(EmptyParam plan)	The identifier of the new plan for this subscription item.
SubscriptionItemUpdateParams.Builder	setPlan(String plan)	The identifier of the new plan for this subscription item.
SubscriptionItemUpdateParams.Builder	setPrice(EmptyParam price)	The ID of the price object.
SubscriptionItemUpdateParams.Builder	setPrice(String price)	The ID of the price object.
SubscriptionItemUpdateParams.Builder	setPriceData(SubscriptionItemUpdateParams.PriceData priceData)	Data used to generate a new Price object inline.
SubscriptionItemUpdateParams.Builder	setProrationBehavior(SubscriptionItemUpdateParams.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.
SubscriptionItemUpdateParams.Builder	setProrationDate(Long prorationDate)	If set, the proration will be calculated as though the subscription was updated at the given time.
SubscriptionItemUpdateParams.Builder	setQuantity(Long quantity)	The quantity you'd like to apply to the subscription item you're creating.
SubscriptionItemUpdateParams.Builder	setTaxRates(EmptyParam taxRates)	A list of Tax Rate ids.
SubscriptionItemUpdateParams.Builder	setTaxRates(List<String> taxRates)	A list of Tax Rate ids.

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 SubscriptionItemUpdateParams build()

Finalize and obtain parameter instance from this builder.

setBillingThresholds

public SubscriptionItemUpdateParams.Builder setBillingThresholds(SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.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.

addDiscount

public SubscriptionItemUpdateParams.Builder addDiscount(SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.discounts for the field documentation.

addAllDiscount

public SubscriptionItemUpdateParams.Builder addAllDiscount(List<SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.discounts for the field documentation.

setDiscounts

public SubscriptionItemUpdateParams.Builder setDiscounts(EmptyParam discounts)

The coupons to redeem into discounts for the subscription item.

setDiscounts

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

The coupons to redeem into discounts for the subscription item.

addExpand

public SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.expand for the field documentation.

addAllExpand

public SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.expand for the field documentation.

putExtraParam

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

putAllExtraParam

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

putMetadata

public SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.metadata for the field documentation.

putAllMetadata

public SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.metadata for the field documentation.

setMetadata

public SubscriptionItemUpdateParams.Builder setMetadata(EmptyParam metadata)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

setMetadata

public SubscriptionItemUpdateParams.Builder setMetadata(Map<String,String> metadata)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

setOffSession

public SubscriptionItemUpdateParams.Builder setOffSession(Boolean offSession)

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).

setPaymentBehavior

public SubscriptionItemUpdateParams.Builder setPaymentBehavior(SubscriptionItemUpdateParams.PaymentBehavior paymentBehavior)

Controls how Stripe handles payment when a subscription update requires payment and collection_method=charge_automatically.

setPlan

public SubscriptionItemUpdateParams.Builder setPlan(String plan)

The identifier of the new plan for this subscription item.

setPlan

public SubscriptionItemUpdateParams.Builder setPlan(EmptyParam plan)

The identifier of the new plan for this subscription item.

setPrice

public SubscriptionItemUpdateParams.Builder setPrice(String price)

The ID of the price object. One of price or price_data is required. When changing a subscription item's price, quantity is set to 1 unless a quantity parameter is provided.

setPrice

public SubscriptionItemUpdateParams.Builder setPrice(EmptyParam price)

The ID of the price object. One of price or price_data is required. When changing a subscription item's price, quantity is set to 1 unless a quantity parameter is provided.

setPriceData

public SubscriptionItemUpdateParams.Builder setPriceData(SubscriptionItemUpdateParams.PriceData priceData)

Data used to generate a new Price object inline. One of price or price_data is required.

setProrationBehavior

public SubscriptionItemUpdateParams.Builder setProrationBehavior(SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.Builder setQuantity(Long quantity)

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

addTaxRate

public SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.taxRates for the field documentation.

addAllTaxRate

public SubscriptionItemUpdateParams.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 SubscriptionItemUpdateParams.taxRates for the field documentation.

setTaxRates

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