com.stripe.param

Class SubscriptionItemDeleteParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionItemDeleteParams

public class SubscriptionItemDeleteParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionItemDeleteParams.Builder
static class	SubscriptionItemDeleteParams.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 SubscriptionItemDeleteParams.Builder	builder()
java.lang.Boolean	getClearUsage() Delete all usage for the given subscription item.
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.Boolean	getProrate() This field has been renamed to proration_behavior.
SubscriptionItemDeleteParams.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.

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 SubscriptionItemDeleteParams.Builder builder()

getClearUsage

public java.lang.Boolean getClearUsage()

Delete all usage for the given subscription item. Allowed only when the current plan's usage_type is metered.

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.

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