Class: Stripe::V2::Billing::MeterEventService::CreateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/v2/billing/meter_event_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(event_name: nil, identifier: nil, payload: nil, timestamp: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



25
26
27
28
29
30
 
# File 'lib/stripe/services/v2/billing/meter_event_service.rb', line 25

def initialize(event_name: nil, identifier: nil, payload: nil, timestamp: nil)
  @event_name = event_name
  @identifier = identifier
  @payload = payload
  @timestamp = timestamp
end

Instance Attribute Details

#event_name ⇒ Object

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



10
11
12
 
# File 'lib/stripe/services/v2/billing/meter_event_service.rb', line 10

def event_name
  @event_name
end

#identifier ⇒ Object

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.



14
15
16
 
# File 'lib/stripe/services/v2/billing/meter_event_service.rb', line 14

def identifier
  @identifier
end

#payload ⇒ Object

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](docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).



20
21
22
 
# File 'lib/stripe/services/v2/billing/meter_event_service.rb', line 20

def payload
  @payload
end

#timestamp ⇒ Object

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.



23
24
25
 
# File 'lib/stripe/services/v2/billing/meter_event_service.rb', line 23

def timestamp
  @timestamp
end