Package com.stripe.model.billing

Class MeterEventSummary

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.billing.MeterEventSummary
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class MeterEventSummary extends ApiResource implements HasId
A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much usage was accrued by a customer for that period.

Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.

  • Constructor Details

    • MeterEventSummary

      public MeterEventSummary()

  • Method Details

    • list

      public static MeterEventSummaryCollection list(String id, Map<String,Object> params) throws StripeException
      Retrieve a list of billing meter event summaries.
      Throws:
      StripeException

    • list

      public static MeterEventSummaryCollection list(String id, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieve a list of billing meter event summaries.
      Throws:
      StripeException

    • list

      public static MeterEventSummaryCollection list(String id, MeterEventSummaryListParams params) throws StripeException
      Retrieve a list of billing meter event summaries.
      Throws:
      StripeException

    • list

      public static MeterEventSummaryCollection list(String id, MeterEventSummaryListParams params, RequestOptions options) throws StripeException
      Retrieve a list of billing meter event summaries.
      Throws:
      StripeException

    • getAggregatedValue

      public BigDecimal getAggregatedValue()
      Aggregated value of all the events within start_time (inclusive) and end_time (inclusive). The aggregation strategy is defined on meter via default_aggregation.

    • getDimensions

      public Map<String,String> getDimensions()
      Key-value pairs of dimension values for event summaries with grouping on dimensions.

    • getEndTime

      public Long getEndTime()
      End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.

    • 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.

    • getMeter

      public String getMeter()
      The meter associated with this event summary.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to billing.meter_event_summary.

    • getStartTime

      public Long getStartTime()
      Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.

    • setAggregatedValue

      public void setAggregatedValue(BigDecimal aggregatedValue)
      Aggregated value of all the events within start_time (inclusive) and end_time (inclusive). The aggregation strategy is defined on meter via default_aggregation.

    • setDimensions

      public void setDimensions(Map<String,String> dimensions)
      Key-value pairs of dimension values for event summaries with grouping on dimensions.

    • setEndTime

      public void setEndTime(Long endTime)
      End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.

    • 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.

    • setMeter

      public void setMeter(String meter)
      The meter associated with this event summary.

    • 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_event_summary.

    • setStartTime

      public void setStartTime(Long startTime)
      Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.

    • 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