com.stripe.param

Class SubscriptionItemCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionItemCreateParams

public class SubscriptionItemCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionItemCreateParams.BillingThresholds
static class	SubscriptionItemCreateParams.Builder
static class	SubscriptionItemCreateParams.PaymentBehavior Usage threshold that triggers the subscription to advance to a new billing period.

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static SubscriptionItemCreateParams.Builder	builder()
java.lang.Object	getBillingThresholds() Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
SubscriptionItemCreateParams.PaymentBehavior	getPaymentBehavior() Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid.
java.lang.String	getPlan() The identifier of the plan to add to the subscription.
java.lang.Boolean	getProrate() Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a billing cycle.
java.lang.Long	getProrationDate() If set, the proration will be calculated as though the subscription was updated at the given time.
java.lang.Long	getQuantity() The quantity you'd like to apply to the subscription item you're creating.
java.lang.String	getSubscription() The identifier of the subscription to modify.
java.lang.Object	getTaxRates() A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SubscriptionItemCreateParams.Builder builder()

getBillingThresholds

public java.lang.Object getBillingThresholds()

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.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

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.

getPaymentBehavior

public SubscriptionItemCreateParams.PaymentBehavior getPaymentBehavior()

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.

getPlan

public java.lang.String getPlan()

The identifier of the plan to add to the subscription.

getProrate

public java.lang.Boolean getProrate()

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

getProrationDate

public java.lang.Long getProrationDate()

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.

getQuantity

public java.lang.Long getQuantity()

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

getSubscription

public java.lang.String getSubscription()

The identifier of the subscription to modify.

getTaxRates

public java.lang.Object getTaxRates()

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.