Class: Stripe::Billing::MeterService::CreateParams

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

Defined Under Namespace

Classes: CustomerMapping, DefaultAggregation, ValueSettings

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(customer_mapping: nil, default_aggregation: nil, display_name: nil, event_name: nil, event_time_window: nil, expand: nil, value_settings: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/stripe/services/billing/meter_service.rb', line 86

def initialize(
  customer_mapping: nil,
  default_aggregation: nil,
  display_name: nil,
  event_name: nil,
  event_time_window: nil,
  expand: nil,
  value_settings: nil
)
  @customer_mapping = customer_mapping
  @default_aggregation = default_aggregation
  @display_name = display_name
  @event_name = event_name
  @event_time_window = event_time_window
  @expand = expand
  @value_settings = value_settings
end

Instance Attribute Details

#customer_mapping ⇒ Object

Fields that specify how to map a meter event to a customer.



72
73
74
 
# File 'lib/stripe/services/billing/meter_service.rb', line 72

def customer_mapping
  @customer_mapping
end

#default_aggregation ⇒ Object

The default settings to aggregate a meter’s events with.



74
75
76
 
# File 'lib/stripe/services/billing/meter_service.rb', line 74

def default_aggregation
  @default_aggregation
end

#display_name ⇒ Object

The meter’s name. Not visible to the customer.



76
77
78
 
# File 'lib/stripe/services/billing/meter_service.rb', line 76

def display_name
  @display_name
end

#event_name ⇒ Object

The name of the meter event to record usage for. Corresponds with the ‘event_name` field on meter events.



78
79
80
 
# File 'lib/stripe/services/billing/meter_service.rb', line 78

def event_name
  @event_name
end

#event_time_window ⇒ Object

The time window which meter events have been pre-aggregated for, if any.



80
81
82
 
# File 'lib/stripe/services/billing/meter_service.rb', line 80

def event_time_window
  @event_time_window
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



82
83
84
 
# File 'lib/stripe/services/billing/meter_service.rb', line 82

def expand
  @expand
end

#value_settings ⇒ Object

Fields that specify how to calculate a meter event’s value.



84
85
86
 
# File 'lib/stripe/services/billing/meter_service.rb', line 84

def value_settings
  @value_settings
end