class Stripe::BillingMeter

• Stripe::BillingMeter
• Reference
• Object

Overview

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.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

stripe/models/billing_meter.cr

Constant Summary

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(*, 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 Method Summary

• #==(other : self)

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

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #display_name : String | Nil
• #display_name=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #event_name : String | Nil
• #event_name=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #event_time_window : String | Nil
• #event_time_window=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #status : String | Nil
• #status=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #updated : Int64 | Nil
• #updated=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

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

  Custom attribute writer method checking allowed values (enum).

Constructor Detail

Instance Method Detail