Package com.stripe.param.billing

Class MeterUsageRetrieveParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.billing.MeterUsageRetrieveParams

public class MeterUsageRetrieveParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MeterUsageRetrieveParams.Builder
static class	MeterUsageRetrieveParams.Meter
static enum	MeterUsageRetrieveParams.Timezone	Add all map key/value pairs to `tenantFilters` map.
static enum	MeterUsageRetrieveParams.ValueGroupingWindow

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 MeterUsageRetrieveParams.Builder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getCustomer()	Required. The customer id to fetch meter usage data for.
Long	getEndTime()	Required. The timestamp from when to stop aggregating meter events (exclusive).
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.
List<MeterUsageRetrieveParams.Meter>	getMeters()	An array of meter parameters to specify which meters to include in the usage data.
Long	getStartTime()	Required. The timestamp from when to start aggregating meter events (inclusive).
MeterUsageRetrieveParams.Timezone	getTimezone()	The timezone to use for the start and end times.
MeterUsageRetrieveParams.ValueGroupingWindow	getValueGroupingWindow()	Specifies what granularity to use when aggregating meter usage events.
int	hashCode()

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static MeterUsageRetrieveParams.Builder builder()

getCustomer

public String getCustomer()

Required. The customer id to fetch meter usage data for.

getEndTime

public Long getEndTime()

Required. The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.

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.

getMeters

public List<MeterUsageRetrieveParams.Meter> getMeters()

An array of meter parameters to specify which meters to include in the usage data. If not specified, usage across all meters for the customer is included.

getStartTime

public Long getStartTime()

Required. The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.

getTimezone

public MeterUsageRetrieveParams.Timezone getTimezone()

The timezone to use for the start and end times. Defaults to UTC if not specified.

getValueGroupingWindow

public MeterUsageRetrieveParams.ValueGroupingWindow getValueGroupingWindow()

Specifies what granularity to use when aggregating meter usage events. If not specified, a single event would be returned for the specified time range.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object