Class: Stripe::Billing::MeterEventSummary

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/billing/meter_event_summary.rb

Overview

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.

Constant Summary collapse

OBJECT_NAME = 
"billing.meter_event_summary"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#aggregated_value ⇒ Object (readonly)

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



17
18
19
 
# File 'lib/stripe/resources/billing/meter_event_summary.rb', line 17

def aggregated_value
  @aggregated_value
end

#end_time ⇒ Object (readonly)

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



19
20
21
 
# File 'lib/stripe/resources/billing/meter_event_summary.rb', line 19

def end_time
  @end_time
end

#id ⇒ Object (readonly)

Unique identifier for the object.



21
22
23
 
# File 'lib/stripe/resources/billing/meter_event_summary.rb', line 21

def id
  @id
end

#livemode ⇒ Object (readonly)

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



23
24
25
 
# File 'lib/stripe/resources/billing/meter_event_summary.rb', line 23

def livemode
  @livemode
end

#meter ⇒ Object (readonly)

The meter associated with this event summary.



25
26
27
 
# File 'lib/stripe/resources/billing/meter_event_summary.rb', line 25

def meter
  @meter
end

#object ⇒ Object (readonly)

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



27
28
29
 
# File 'lib/stripe/resources/billing/meter_event_summary.rb', line 27

def object
  @object
end

#start_time ⇒ Object (readonly)

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



29
30
31
 
# File 'lib/stripe/resources/billing/meter_event_summary.rb', line 29

def start_time
  @start_time
end

Class Method Details

.object_name ⇒ Object 



12
13
14
 
# File 'lib/stripe/resources/billing/meter_event_summary.rb', line 12

def self.object_name
  "billing.meter_event_summary"
end