com.stripe.param

Class SubscriptionItemUpdateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionItemUpdateParams

public class SubscriptionItemUpdateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionItemUpdateParams.BillingThresholds
static class	SubscriptionItemUpdateParams.Builder
static class	SubscriptionItemUpdateParams.PaymentBehavior Configures how the quantity per period should be determined.
static class	SubscriptionItemUpdateParams.PriceData Usage threshold that triggers the subscription to advance to a new billing period.
static class	SubscriptionItemUpdateParams.ProrationBehavior

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 SubscriptionItemUpdateParams.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.lang.Object	getMetadata() Set of key-value pairs that you can attach to an object.
java.lang.Boolean	getOffSession() Indicates if a customer is on or off-session while an invoice payment is attempted.
SubscriptionItemUpdateParams.PaymentBehavior	getPaymentBehavior() Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid.
java.lang.Object	getPlan() The identifier of the new plan for this subscription item.
java.lang.Object	getPrice() The ID of the price object.
SubscriptionItemUpdateParams.PriceData	getPriceData() Data used to generate a new price object inline.
java.lang.Boolean	getProrate() This field has been renamed to proration_behavior.
SubscriptionItemUpdateParams.ProrationBehavior	getProrationBehavior() 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.
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.Object	getTaxRates() A list of Tax Rate 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 SubscriptionItemUpdateParams.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.lang.Object 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

getOffSession

public java.lang.Boolean getOffSession()

Indicates if a customer is on or off-session while an invoice payment is attempted.

getPaymentBehavior

public SubscriptionItemUpdateParams.PaymentBehavior getPaymentBehavior()

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 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 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 to learn more.

getPlan

public java.lang.Object getPlan()

The identifier of the new plan for this subscription item.

getPrice

public java.lang.Object getPrice()

The ID of the price object.

getPriceData

public SubscriptionItemUpdateParams.PriceData getPriceData()

Data used to generate a new price object inline.

getProrate

public java.lang.Boolean getProrate()

This field has been renamed to proration_behavior. prorate=true can be replaced with proration_behavior=create_prorations and prorate=false can be replaced with proration_behavior=none.

getProrationBehavior

public SubscriptionItemUpdateParams.ProrationBehavior getProrationBehavior()

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. Valid values are create_prorations, none, or always_invoice.

Passing create_prorations will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass always_invoice.

Prorations can be disabled by passing none.

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 endpoint.

getQuantity

public java.lang.Long getQuantity()

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

getTaxRates

public java.lang.Object getTaxRates()

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.