class

Stripe::BillingAlert

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

A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.

Constants

ERROR_MESSAGE_FOR_ALERT_TYPE = "invalid value for \"alert_type\", must be one of [usage_threshold]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [billing.alert]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [active, archived, inactive]."
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_TITLE = 5000
VALID_VALUES_FOR_ALERT_TYPE = String.static_array("usage_threshold")
VALID_VALUES_FOR_OBJECT = String.static_array("billing.alert")
VALID_VALUES_FOR_STATUS = String.static_array("active", "archived", "inactive")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, alert_type : String | Nil = nil, filter : Stripe::BillingAlertFilter | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, status : String | Nil = nil, title : String | Nil = nil, usage_threshold_config : Stripe::BillingAlertUsageThresholdConfig | 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

alert_type

Defines the type of the alert.

Source
alert_type=(new_value : String | Nil)

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

Source
filter
Source
filter=(new_value : Stripe::BillingAlertFilter | Nil)

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

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

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

Source
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

Status of the alert. This can be active, inactive or archived.

Source
status=(new_value : String | Nil)

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

Source
title

Title of the alert.

Source
title=(new_value : String | Nil)

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

Source
usage_threshold_config
Source
usage_threshold_config=(new_value : Stripe::BillingAlertUsageThresholdConfig | Nil)

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