Class: Stripe::V2::Billing::MeterEvent

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

Overview

Fix me empty_doc_string.

Constant Summary collapse

OBJECT_NAME = 
"v2.billing.meter_event"

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

#created ⇒ Object (readonly)

The creation time of this meter event.



15
16
17
 
# File 'lib/stripe/resources/v2/billing/meter_event.rb', line 15

def created
  @created
end

#event_name ⇒ Object (readonly)

The name of the meter event. Corresponds with the ‘event_name` field on a meter.



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

def event_name
  @event_name
end

#identifier ⇒ Object (readonly)

A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We’ll enforce uniqueness within a rolling 24 hour period.



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

def identifier
  @identifier
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.



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

def livemode
  @livemode
end

#object ⇒ Object (readonly)

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



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

def object
  @object
end

#payload ⇒ Object (readonly)

The payload of the event. This must contain the fields corresponding to a meter’s ‘customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the payload.



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

def payload
  @payload
end

#timestamp ⇒ Object (readonly)

The time of the event. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.



30
31
32
 
# File 'lib/stripe/resources/v2/billing/meter_event.rb', line 30

def timestamp
  @timestamp
end

Class Method Details

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/v2/billing/meter_event.rb', line 10

def self.object_name
  "v2.billing.meter_event"
end