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.cr

Constant 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

Constructor Detail

Instance Method Detail