class Stripe::Discount

• Stripe::Discount
• Reference
• Object

Overview

A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to. Related guide: Applying discounts to subscriptions

Included Modules

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

Defined in:

Constant Summary

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

MAX_LENGTH_FOR_CHECKOUT_SESSION = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_INVOICE = 5000

MAX_LENGTH_FOR_INVOICE_ITEM = 5000

MAX_LENGTH_FOR_SUBSCRIPTION = 5000

MAX_LENGTH_FOR_SUBSCRIPTION_ITEM = 5000

VALID_VALUES_FOR_OBJECT = String.static_array("discount")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, checkout_session : String | Nil = nil, coupon : Stripe::Coupon | Nil = nil, customer : Stripe::DeletedDiscountCustomer | Nil = nil, _end : Int64 | Nil = nil, id : String | Nil = nil, invoice : String | Nil = nil, invoice_item : String | Nil = nil, object : String | Nil = nil, promotion_code : Stripe::DeletedDiscountPromotionCode | Nil = nil, start : Int64 | Nil = nil, subscription : String | Nil = nil, subscription_item : String | 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.

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

  Custom attribute writer method checking allowed values (enum).

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

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

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

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

  Custom attribute writer method checking allowed values (enum).

• #promotion_code : Stripe::DeletedDiscountPromotionCode | Nil
• #promotion_code=(new_value : Stripe::DeletedDiscountPromotionCode | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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