Class: Falsify::DiscountCode

Inherits:
Object
  • Object
show all
Extended by:
Enumerize
Defined in:
lib/falsify/models/order/discount_code.rb

Overview

Discount codes to be applied to an order.

Instance Attribute Summary collapse

Instance Attribute Details

#amount ⇒ String

The value of the discount to be deducted from the order total. The type field determines how this value is calculated. After an order is created, this field returns the calculated amount.

Returns:

  • (String) 


11
12
13
 
# File 'lib/falsify/models/order/discount_code.rb', line 11

def amount
  @amount
end

#code ⇒ String

The discount code.

Returns:

  • (String) 


14
15
16
 
# File 'lib/falsify/models/order/discount_code.rb', line 14

def code
  @code
end

#type ⇒ :fixed_amount, ...

The type of discount. Default value: fixed_amount. Valid values:

  • fixed_amount: Applies amount as a unit of the store's currency. For example, if amount is 30 and the store's currency is USD, then 30 USD is deducted from the order total when the discount is applied.
  • percentage: Applies a discount of amount as a percentage of the order total.
  • shipping: Applies a free shipping discount on orders that have a shipping rate less than or equal to amount. For example, if amount is 30, then the discount will give the customer free shipping for any shipping rate that is less than or equal to $30.

Returns:

  • (:fixed_amount, :percentage, :shipping) 


24
 
# File 'lib/falsify/models/order/discount_code.rb', line 24

enumerize :status, in: [:fixed_amount, :percentage, :shipping]