class

Stripe::BillingMeterEvent

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage. Meter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [billing.meter_event]."
MAX_LENGTH_FOR_EVENT_NAME = 100
MAX_LENGTH_FOR_IDENTIFIER = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("billing.meter_event")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, created : Int64 | Nil = nil, event_name : String | Nil = nil, identifier : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, payload : Hash(String, String) | Nil = nil, timestamp : Int64 | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

created

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

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
event_name

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

Source
event_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] event_name Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

identifier

A unique identifier for the event.

Source
identifier=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] identifier Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

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

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
object

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

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
payload

The payload of the event. This contains 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.

Source
payload=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payload Object to be assigned

Source
timestamp

The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.

Source
timestamp=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] timestamp Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source