Package 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 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.SubscriptionItemDeleteParams.ProrationBehavior
getProrationBehavior()
Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resettingbilling_cycle_anchor=now
, or starting a trial), or if an item'squantity
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
-
-
-
-
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'susage_type
ismetered
.
-
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.
-
getProrationBehavior
public SubscriptionItemDeleteParams.ProrationBehavior getProrationBehavior()
Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resettingbilling_cycle_anchor=now
, or starting a trial), or if an item'squantity
changes. Valid values arecreate_prorations
,none
, oralways_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, passalways_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.
-
-