com.stripe.param

Class SubscriptionItemUpdateParams.Builder

java.lang.Object

com.stripe.param.SubscriptionItemUpdateParams.Builder

Enclosing class:

SubscriptionItemUpdateParams

public static class SubscriptionItemUpdateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SubscriptionItemUpdateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
SubscriptionItemUpdateParams.Builder	addAllTaxRate(java.util.List<java.lang.String> elements) Add all elements to `taxRates` list.
SubscriptionItemUpdateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
SubscriptionItemUpdateParams.Builder	addTaxRate(java.lang.String element) Add an element to `taxRates` list.
SubscriptionItemUpdateParams	build() Finalize and obtain parameter instance from this builder.
SubscriptionItemUpdateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
SubscriptionItemUpdateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
SubscriptionItemUpdateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
SubscriptionItemUpdateParams.Builder	putMetadata(java.lang.String key, java.lang.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	setOffSession(java.lang.Boolean offSession)
SubscriptionItemUpdateParams.Builder	setPaymentBehavior(SubscriptionItemUpdateParams.PaymentBehavior paymentBehavior)
SubscriptionItemUpdateParams.Builder	setPlan(EmptyParam plan) The identifier of the new plan for this subscription item.
SubscriptionItemUpdateParams.Builder	setPlan(java.lang.String plan) The identifier of the new plan for this subscription item.
SubscriptionItemUpdateParams.Builder	setProrate(java.lang.Boolean prorate) Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a billing cycle.
SubscriptionItemUpdateParams.Builder	setProrationDate(java.lang.Long prorationDate) If set, the proration will be calculated as though the subscription was updated at the given time.
SubscriptionItemUpdateParams.Builder	setQuantity(java.lang.Long quantity) The quantity you'd like to apply to the subscription item you're creating.
SubscriptionItemUpdateParams.Builder	setTaxRates(EmptyParam taxRates) The tax rates which apply to this `subscription_item`.
SubscriptionItemUpdateParams.Builder	setTaxRates(java.util.List<java.lang.String> taxRates) The tax rates which apply to this `subscription_item`.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

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.

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.

addExpand

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

addAllExpand

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

putExtraParam

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

putAllExtraParam

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

putMetadata

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

putAllMetadata

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

setOffSession

public SubscriptionItemUpdateParams.Builder setOffSession(java.lang.Boolean offSession)

setPaymentBehavior

public SubscriptionItemUpdateParams.Builder setPaymentBehavior(SubscriptionItemUpdateParams.PaymentBehavior paymentBehavior)

setPlan

public SubscriptionItemUpdateParams.Builder setPlan(java.lang.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.

setProrate

public SubscriptionItemUpdateParams.Builder setProrate(java.lang.Boolean prorate)

Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a billing cycle.

setProrationDate

public SubscriptionItemUpdateParams.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](#retrieve_customer_invoice) endpoint.

setQuantity

public SubscriptionItemUpdateParams.Builder setQuantity(java.lang.Long quantity)

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

addTaxRate

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

addAllTaxRate

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

setTaxRates

public SubscriptionItemUpdateParams.Builder setTaxRates(EmptyParam taxRates)

The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.

setTaxRates

public SubscriptionItemUpdateParams.Builder setTaxRates(java.util.List<java.lang.String> taxRates)

The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.