class Stripe::Coupon

• Stripe::Coupon
• Reference
• Object

Overview

A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

ERROR_MESSAGE_FOR_DURATION = "invalid value for \"duration\", must be one of [forever, once, repeating]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [coupon]."

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_NAME = 5000

VALID_VALUES_FOR_DURATION = String.static_array("forever", "once", "repeating")

VALID_VALUES_FOR_OBJECT = String.static_array("coupon")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, amount_off : Int64 | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, duration : String | Nil = nil, duration_in_months : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, max_redemptions : Int64 | Nil = nil, metadata : Hash(String, String) | Nil = nil, name : String | Nil = nil, object : String | Nil = nil, percent_off : Float64 | Nil = nil, redeem_by : Int64 | Nil = nil, times_redeemed : Int64 | Nil = nil, valid : Bool | Nil = nil, applies_to : Stripe::CouponAppliesTo | Nil = nil, currency_options : Hash(String, Stripe::CouponCurrencyOption) | 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.

• #amount_off : Int64 | Nil
• #amount_off=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #applies_to : Stripe::CouponAppliesTo | Nil
• #applies_to=(new_value : Stripe::CouponAppliesTo | 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).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency_options : Hash(String, Stripe::CouponCurrencyOption) | Nil
• #currency_options=(new_value : Hash(String, Stripe::CouponCurrencyOption) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #duration : String | Nil
• #duration=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #duration_in_months : Int64 | Nil
• #duration_in_months=(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).

• #name : String | Nil
• #name=(new_value : 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).

• #percent_off : Float64 | Nil
• #percent_off=(new_value : Float64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #redeem_by : Int64 | Nil
• #redeem_by=(new_value : Int64 | 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 | Nil
• #valid=(new_value : Bool | 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