class

Stripe::BillingMeter

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

A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.

Constants

ERROR_MESSAGE_FOR_EVENT_TIME_WINDOW = "invalid value for \"event_time_window\", must be one of [day, hour]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [billing.meter]."

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [active, inactive]."

MAX_LENGTH_FOR_DISPLAY_NAME = 5000

MAX_LENGTH_FOR_EVENT_NAME = 5000

MAX_LENGTH_FOR_ID = 5000

VALID_VALUES_FOR_EVENT_TIME_WINDOW = String.static_array("day", "hour")

VALID_VALUES_FOR_OBJECT = String.static_array("billing.meter")

VALID_VALUES_FOR_STATUS = String.static_array("active", "inactive")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, created : Int64 | Nil = nil, customer_mapping : Stripe::BillingMeterResourceCustomerMappingSettings | Nil = nil, default_aggregation : Stripe::BillingMeterResourceAggregationSettings | Nil = nil, display_name : String | Nil = nil, event_name : String | Nil = nil, event_time_window : String | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, status : String | Nil = nil, status_transitions : Stripe::BillingMeterResourceBillingMeterStatusTransitions | Nil = nil, updated : Int64 | Nil = nil, value_settings : Stripe::BillingMeterResourceBillingMeterValue | Nil = nil)

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

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.

created=(new_value : Int64 | Nil)

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

customer_mapping

customer_mapping=(new_value : Stripe::BillingMeterResourceCustomerMappingSettings | Nil)

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

default_aggregation

default_aggregation=(new_value : Stripe::BillingMeterResourceAggregationSettings | Nil)

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

display_name

The meter's name.

display_name=(new_value : String | Nil)

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

event_name

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

event_name=(new_value : String | Nil)

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

event_time_window

The time window to pre-aggregate meter events for, if any.

event_time_window=(new_value : String | Nil)

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

hash(hasher)

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

id

Unique identifier for the object.

id=(new_value : String | Nil)

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

list_invalid_properties

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

livemode

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

livemode=(new_value : Bool | Nil)

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

object

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

object=(new_value : String | Nil)

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

status

The meter's status.

status=(new_value : String | Nil)

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

status_transitions

status_transitions=(new_value : Stripe::BillingMeterResourceBillingMeterStatusTransitions | Nil)

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

updated

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

updated=(new_value : Int64 | Nil)

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

valid?

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

value_settings

value_settings=(new_value : Stripe::BillingMeterResourceBillingMeterValue | Nil)

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