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 class
UsageRecordCreateOnSubscriptionItemParams.Action
static class
UsageRecordCreateOnSubscriptionItemParams.Builder
static class
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UsageRecordCreateOnSubscriptionItemParams.Builder
builder()
UsageRecordCreateOnSubscriptionItemParams.Action
getAction()
Valid values areincrement
(default) orset
.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.Object
getTimestamp()
The timestamp for the usage event.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static UsageRecordCreateOnSubscriptionItemParams.Builder builder()
-
getAction
public UsageRecordCreateOnSubscriptionItemParams.Action getAction()
Valid values areincrement
(default) orset
. When usingincrement
the specifiedquantity
will be added to the usage at the specified timestamp. Theset
action will overwrite the usage quantity at that timestamp. If the subscription has 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.Object getTimestamp()
The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the providedsubscription_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.
-
-