class

Stripe::BillingMeterEventAdjustment

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

A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [cancel]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [billing.meter_event_adjustment]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [complete, pending]."
MAX_LENGTH_FOR_EVENT_NAME = 100
VALID_VALUES_FOR__TYPE = String.static_array("cancel")
VALID_VALUES_FOR_OBJECT = String.static_array("billing.meter_event_adjustment")
VALID_VALUES_FOR_STATUS = String.static_array("complete", "pending")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, cancel : Stripe::BillingMeterEventAdjustmentCancel | Nil = nil, event_name : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, status : String | Nil = nil, _type : String | 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

_type

Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.

Source
_type=(new_value : String | Nil)

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

Source
cancel
Source
cancel=(new_value : Stripe::BillingMeterEventAdjustmentCancel | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] cancel 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

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
status

The meter event adjustment's status.

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status 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