Package com.stripe.model.billing

Class Meter

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.billing.Meter

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class Meter
extends ApiResource
implements HasId

Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.

Related guide: Usage based billing

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Meter.CustomerMapping	For more details about CustomerMapping, please refer to the API Reference.
static class	Meter.DefaultAggregation	For more details about DefaultAggregation, please refer to the API Reference.
static class	Meter.StatusTransitions	For more details about StatusTransitions, please refer to the API Reference.
static class	Meter.ValueSettings	For more details about ValueSettings, please refer to the API Reference.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Meter()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static Meter	create(MeterCreateParams params)	Creates a billing meter.
static Meter	create(MeterCreateParams params, RequestOptions options)	Creates a billing meter.
static Meter	create(Map<String,Object> params)	Creates a billing meter.
static Meter	create(Map<String,Object> params, RequestOptions options)	Creates a billing meter.
Meter	deactivate()	When a meter is deactivated, no more meter events will be accepted for this meter.
Meter	deactivate(RequestOptions options)	When a meter is deactivated, no more meter events will be accepted for this meter.
Meter	deactivate(MeterDeactivateParams params)	When a meter is deactivated, no more meter events will be accepted for this meter.
Meter	deactivate(MeterDeactivateParams params, RequestOptions options)	When a meter is deactivated, no more meter events will be accepted for this meter.
Meter	deactivate(Map<String,Object> params)	When a meter is deactivated, no more meter events will be accepted for this meter.
Meter	deactivate(Map<String,Object> params, RequestOptions options)	When a meter is deactivated, no more meter events will be accepted for this meter.
boolean	equals(Object o)
MeterEventSummaryCollection	eventSummaries(MeterEventSummariesParams params)	Retrieve a list of billing meter event summaries.
MeterEventSummaryCollection	eventSummaries(MeterEventSummariesParams params, RequestOptions options)	Retrieve a list of billing meter event summaries.
MeterEventSummaryCollection	eventSummaries(Map<String,Object> params)	Retrieve a list of billing meter event summaries.
MeterEventSummaryCollection	eventSummaries(Map<String,Object> params, RequestOptions options)	Retrieve a list of billing meter event summaries.
Long	getCreated()	Time at which the object was created.
Meter.CustomerMapping	getCustomerMapping()
Meter.DefaultAggregation	getDefaultAggregation()
List<String>	getDimensionPayloadKeys()	Set of keys that will be used to group meter events by.
String	getDisplayName()	The meter's name.
String	getEventName()	The name of the meter event to record usage for.
String	getEventTimeWindow()	The time window which meter events have been pre-aggregated for, if any.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getObject()	String representing the object's type.
String	getStatus()	The meter's status.
Meter.StatusTransitions	getStatusTransitions()
Long	getUpdated()	Time at which the object was last updated.
Meter.ValueSettings	getValueSettings()
int	hashCode()
static MeterCollection	list(MeterListParams params)	Retrieve a list of billing meters.
static MeterCollection	list(MeterListParams params, RequestOptions options)	Retrieve a list of billing meters.
static MeterCollection	list(Map<String,Object> params)	Retrieve a list of billing meters.
static MeterCollection	list(Map<String,Object> params, RequestOptions options)	Retrieve a list of billing meters.
Meter	reactivate()	When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
Meter	reactivate(RequestOptions options)	When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
Meter	reactivate(MeterReactivateParams params)	When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
Meter	reactivate(MeterReactivateParams params, RequestOptions options)	When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
Meter	reactivate(Map<String,Object> params)	When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
Meter	reactivate(Map<String,Object> params, RequestOptions options)	When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
static Meter	retrieve(String id)	Retrieves a billing meter given an ID.
static Meter	retrieve(String id, RequestOptions options)	Retrieves a billing meter given an ID.
static Meter	retrieve(String id, MeterRetrieveParams params, RequestOptions options)	Retrieves a billing meter given an ID.
static Meter	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves a billing meter given an ID.
void	setCreated(Long created)	Time at which the object was created.
void	setCustomerMapping(Meter.CustomerMapping customerMapping)
void	setDefaultAggregation(Meter.DefaultAggregation defaultAggregation)
void	setDimensionPayloadKeys(List<String> dimensionPayloadKeys)	Set of keys that will be used to group meter events by.
void	setDisplayName(String displayName)	The meter's name.
void	setEventName(String eventName)	The name of the meter event to record usage for.
void	setEventTimeWindow(String eventTimeWindow)	The time window which meter events have been pre-aggregated for, if any.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setObject(String object)	String representing the object's type.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setStatus(String status)	The meter's status.
void	setStatusTransitions(Meter.StatusTransitions statusTransitions)
void	setUpdated(Long updated)	Time at which the object was last updated.
void	setValueSettings(Meter.ValueSettings valueSettings)
Meter	update(MeterUpdateParams params)	Updates a billing meter.
Meter	update(MeterUpdateParams params, RequestOptions options)	Updates a billing meter.
Meter	update(Map<String,Object> params)	Updates a billing meter.
Meter	update(Map<String,Object> params, RequestOptions options)	Updates a billing meter.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

Meter

public Meter()

Method Details

create

public static Meter create(Map<String,Object> params)
                    throws StripeException

Creates a billing meter.

Throws:

StripeException

create

public static Meter create(Map<String,Object> params,
 RequestOptions options)
                    throws StripeException

Creates a billing meter.

Throws:

StripeException

create

public static Meter create(MeterCreateParams params)
                    throws StripeException

Creates a billing meter.

Throws:

StripeException

create

public static Meter create(MeterCreateParams params,
 RequestOptions options)
                    throws StripeException

Creates a billing meter.

Throws:

StripeException

deactivate

public Meter deactivate()
                 throws StripeException

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

Throws:

StripeException

deactivate

public Meter deactivate(RequestOptions options)
                 throws StripeException

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

Throws:

StripeException

deactivate

public Meter deactivate(Map<String,Object> params)
                 throws StripeException

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

Throws:

StripeException

deactivate

public Meter deactivate(Map<String,Object> params,
 RequestOptions options)
                 throws StripeException

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

Throws:

StripeException

deactivate

public Meter deactivate(MeterDeactivateParams params)
                 throws StripeException

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

Throws:

StripeException

deactivate

public Meter deactivate(MeterDeactivateParams params,
 RequestOptions options)
                 throws StripeException

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

Throws:

StripeException

eventSummaries

public MeterEventSummaryCollection eventSummaries(Map<String,Object> params)
                                           throws StripeException

Retrieve a list of billing meter event summaries.

Throws:

StripeException

eventSummaries

public MeterEventSummaryCollection eventSummaries(Map<String,Object> params,
 RequestOptions options)
                                           throws StripeException

Retrieve a list of billing meter event summaries.

Throws:

StripeException

eventSummaries

public MeterEventSummaryCollection eventSummaries(MeterEventSummariesParams params)
                                           throws StripeException

Retrieve a list of billing meter event summaries.

Throws:

StripeException

eventSummaries

public MeterEventSummaryCollection eventSummaries(MeterEventSummariesParams params,
 RequestOptions options)
                                           throws StripeException

Retrieve a list of billing meter event summaries.

Throws:

StripeException

list

public static MeterCollection list(Map<String,Object> params)
                            throws StripeException

Retrieve a list of billing meters.

Throws:

StripeException

list

public static MeterCollection list(Map<String,Object> params,
 RequestOptions options)
                            throws StripeException

Retrieve a list of billing meters.

Throws:

StripeException

list

public static MeterCollection list(MeterListParams params)
                            throws StripeException

Retrieve a list of billing meters.

Throws:

StripeException

list

public static MeterCollection list(MeterListParams params,
 RequestOptions options)
                            throws StripeException

Retrieve a list of billing meters.

Throws:

StripeException

reactivate

public Meter reactivate()
                 throws StripeException

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

Throws:

StripeException

reactivate

public Meter reactivate(RequestOptions options)
                 throws StripeException

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

Throws:

StripeException

reactivate

public Meter reactivate(Map<String,Object> params)
                 throws StripeException

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

Throws:

StripeException

reactivate

public Meter reactivate(Map<String,Object> params,
 RequestOptions options)
                 throws StripeException

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

Throws:

StripeException

reactivate

public Meter reactivate(MeterReactivateParams params)
                 throws StripeException

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

Throws:

StripeException

reactivate

public Meter reactivate(MeterReactivateParams params,
 RequestOptions options)
                 throws StripeException

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

Throws:

StripeException

retrieve

public static Meter retrieve(String id)
                      throws StripeException

Retrieves a billing meter given an ID.

Throws:

StripeException

retrieve

public static Meter retrieve(String id,
 RequestOptions options)
                      throws StripeException

Retrieves a billing meter given an ID.

Throws:

StripeException

retrieve

public static Meter retrieve(String id,
 Map<String,Object> params,
 RequestOptions options)
                      throws StripeException

Retrieves a billing meter given an ID.

Throws:

StripeException

retrieve

public static Meter retrieve(String id,
 MeterRetrieveParams params,
 RequestOptions options)
                      throws StripeException

Retrieves a billing meter given an ID.

Throws:

StripeException

update

public Meter update(Map<String,Object> params)
             throws StripeException

Updates a billing meter.

Throws:

StripeException

update

public Meter update(Map<String,Object> params,
 RequestOptions options)
             throws StripeException

Updates a billing meter.

Throws:

StripeException

update

public Meter update(MeterUpdateParams params)
             throws StripeException

Updates a billing meter.

Throws:

StripeException

update

public Meter update(MeterUpdateParams params,
 RequestOptions options)
             throws StripeException

Updates a billing meter.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getCustomerMapping

public Meter.CustomerMapping getCustomerMapping()

getDefaultAggregation

public Meter.DefaultAggregation getDefaultAggregation()

getDimensionPayloadKeys

public List<String> getDimensionPayloadKeys()

Set of keys that will be used to group meter events by.

getDisplayName

public String getDisplayName()

The meter's name.

getEventName

public String getEventName()

The name of the meter event to record usage for. Corresponds with the event_name field on meter events.

getEventTimeWindow

public String getEventTimeWindow()

The time window which meter events have been pre-aggregated for, if any.

One of day, or hour.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to billing.meter.

getStatus

public String getStatus()

The meter's status.

One of active, or inactive.

getStatusTransitions

public Meter.StatusTransitions getStatusTransitions()

getUpdated

public Long getUpdated()

Time at which the object was last updated. Measured in seconds since the Unix epoch.

getValueSettings

public Meter.ValueSettings getValueSettings()

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setCustomerMapping

public void setCustomerMapping(Meter.CustomerMapping customerMapping)

setDefaultAggregation

public void setDefaultAggregation(Meter.DefaultAggregation defaultAggregation)

setDimensionPayloadKeys

public void setDimensionPayloadKeys(List<String> dimensionPayloadKeys)

Set of keys that will be used to group meter events by.

setDisplayName

public void setDisplayName(String displayName)

The meter's name.

setEventName

public void setEventName(String eventName)

The name of the meter event to record usage for. Corresponds with the event_name field on meter events.

setEventTimeWindow

public void setEventTimeWindow(String eventTimeWindow)

The time window which meter events have been pre-aggregated for, if any.

One of day, or hour.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to billing.meter.

setStatus

public void setStatus(String status)

The meter's status.

One of active, or inactive.

setStatusTransitions

public void setStatusTransitions(Meter.StatusTransitions statusTransitions)

setUpdated

public void setUpdated(Long updated)

Time at which the object was last updated. Measured in seconds since the Unix epoch.

setValueSettings

public void setValueSettings(Meter.ValueSettings valueSettings)

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

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId