com.stripe.param

Class UsageRecordCreateOnSubscriptionItemParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.UsageRecordCreateOnSubscriptionItemParams

public class UsageRecordCreateOnSubscriptionItemParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsageRecordCreateOnSubscriptionItemParams.Action
static class	UsageRecordCreateOnSubscriptionItemParams.Builder

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 UsageRecordCreateOnSubscriptionItemParams.Builder	builder()
UsageRecordCreateOnSubscriptionItemParams.Action	getAction() Valid values are `increment` (default) or `set`.
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.Long	getQuantity() The usage quantity for the specified timestamp.
java.lang.Long	getTimestamp() The timestamp for the usage event.

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

getAction

public UsageRecordCreateOnSubscriptionItemParams.Action getAction()

Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value.

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.

getQuantity

public java.lang.Long getQuantity()

The usage quantity for the specified timestamp.

getTimestamp

public java.lang.Long getTimestamp()

The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`.