class Stripe::BillingAlert

Overview

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.

Included Modules

Defined in:

stripe/models/billing_alert.cr

Constant Summary

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def alert_type : String | Nil #

[View source]
def alert_type=(new_value : String | Nil) #

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


[View source]
def filter : Stripe::BillingAlertFilter | Nil #

[View source]
def filter=(new_value : Stripe::BillingAlertFilter | Nil) #

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


[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]
def status : String | Nil #

[View source]
def status=(new_value : String | Nil) #

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


[View source]
def title : String | Nil #

[View source]
def title=(new_value : String | Nil) #

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


[View source]
def usage_threshold_config : Stripe::BillingAlertUsageThresholdConfig | Nil #

[View source]
def 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


[View source]
def valid? : Bool #

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


[View source]