class Stripe::PromotionCode
- Stripe::PromotionCode
- Reference
- Object
Overview
A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
stripe/models/promotion_code.crConstant Summary
-
ERROR_MESSAGE_FOR_OBJECT =
"invalid value for \"object\", must be one of [promotion_code]."
-
MAX_LENGTH_FOR_CODE =
5000
-
MAX_LENGTH_FOR_ID =
5000
-
VALID_VALUES_FOR_OBJECT =
String.static_array("promotion_code")
Constructors
- .new(pull : JSON::PullParser)
-
.new(*, active : Bool | Nil = nil, code : String | Nil = nil, coupon : Stripe::Coupon | Nil = nil, created : Int64 | Nil = nil, customer : Stripe::PromotionCodeCustomer | Nil = nil, expires_at : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, max_redemptions : Int64 | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, restrictions : Stripe::PromotionCodesResourceRestrictions | Nil = nil, times_redeemed : Int64 | 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.
- #active : Bool | Nil
-
#active=(new_value : Bool | Nil)
Custom attribute writer method checking allowed values (enum).
- #code : String | Nil
-
#code=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #coupon : Stripe::Coupon | Nil
-
#coupon=(new_value : Stripe::Coupon | Nil)
Custom attribute writer method checking allowed values (enum).
- #created : Int64 | Nil
-
#created=(new_value : Int64 | Nil)
Custom attribute writer method checking allowed values (enum).
- #customer : Stripe::PromotionCodeCustomer | Nil
-
#customer=(new_value : Stripe::PromotionCodeCustomer | Nil)
Custom attribute writer method checking allowed values (enum).
- #expires_at : Int64 | Nil
-
#expires_at=(new_value : Int64 | 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).
- #max_redemptions : Int64 | Nil
-
#max_redemptions=(new_value : Int64 | Nil)
Custom attribute writer method checking allowed values (enum).
- #metadata : Hash(String, String) | Nil
-
#metadata=(new_value : Hash(String, String) | 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).
- #restrictions : Stripe::PromotionCodesResourceRestrictions | Nil
-
#restrictions=(new_value : Stripe::PromotionCodesResourceRestrictions | Nil)
Custom attribute writer method checking allowed values (enum).
- #times_redeemed : Int64 | Nil
-
#times_redeemed=(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
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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] active Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] code Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] coupon Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] customer Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] expires_at Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] max_redemptions Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] restrictions Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] times_redeemed Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid