Package 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	Description
static enum	UsageRecordCreateOnSubscriptionItemParams.Action
static class	UsageRecordCreateOnSubscriptionItemParams.Builder
static enum	UsageRecordCreateOnSubscriptionItemParams.Timestamp

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	Description
static UsageRecordCreateOnSubscriptionItemParams.Builder	builder()
UsageRecordCreateOnSubscriptionItemParams.Action	getAction()	Valid values are increment (default) or set.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Long	getQuantity()	Required. The usage quantity for the specified timestamp.
Object	getTimestamp()	The timestamp for the usage event.

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

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, increment is the only allowed value.

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public Map<String,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 Long getQuantity()

Required. The usage quantity for the specified timestamp.

getTimestamp

public Object getTimestamp()

The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided subscription_item, and must not be in the future. When passing "now", Stripe records usage for the current time. Default is "now" if a value is not provided.