com.stripe.param

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 and Description
Builder()

Method Summary

Modifier and Type	Method and 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) Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid.
SubscriptionItemCreateParams.Builder	setPlan(java.lang.String plan) The identifier of the plan to add to the subscription.
SubscriptionItemCreateParams.Builder	setProrate(java.lang.Boolean prorate) Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a billing cycle.
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](https://stripe.com/docs/api/tax_rates) ids.
SubscriptionItemCreateParams.Builder	setTaxRates(java.util.List<java.lang.String> taxRates) A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids.

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

setPaymentBehavior

public SubscriptionItemCreateParams.Builder setPaymentBehavior(SubscriptionItemCreateParams.PaymentBehavior paymentBehavior)

Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status 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](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first 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 create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.

setPlan

public SubscriptionItemCreateParams.Builder setPlan(java.lang.String plan)

The identifier of the plan to add to the subscription.

setProrate

public SubscriptionItemCreateParams.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 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](#retrieve_customer_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. See SubscriptionItemCreateParams.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. See SubscriptionItemCreateParams.taxRates for the field documentation.

setTaxRates

public SubscriptionItemCreateParams.Builder setTaxRates(EmptyParam taxRates)

A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_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](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.