class

Stripe::PromotionCode

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

A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.

Constants

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)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
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

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

active

Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.

Source
active=(new_value : Bool | Nil)

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

Source
code

The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.

Source
code=(new_value : String | Nil)

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

Source
coupon
Source
coupon=(new_value : Stripe::Coupon | Nil)

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

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

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

Source
customer
Source
customer=(new_value : Stripe::PromotionCodeCustomer | Nil)

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

Source
expires_at

Date at which the promotion code can no longer be redeemed.

Source
expires_at=(new_value : Int64 | Nil)

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

Maximum number of times this promotion code can be redeemed.

Source
max_redemptions=(new_value : Int64 | Nil)

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

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata 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
restrictions
Source
restrictions=(new_value : Stripe::PromotionCodesResourceRestrictions | Nil)

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

Source
times_redeemed

Number of times this promotion code has been used.

Source
times_redeemed=(new_value : Int64 | Nil)

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