Class: Stripe::PromotionCodeCreateParams::Restrictions

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/promotion_code_create_params.rb

Defined Under Namespace

Classes: CurrencyOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(currency_options: nil, first_time_transaction: nil, minimum_amount: nil, minimum_amount_currency: nil) ⇒ Restrictions

Returns a new instance of Restrictions.



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/stripe/params/promotion_code_create_params.rb', line 36

def initialize(
  currency_options: nil,
  first_time_transaction: nil,
  minimum_amount: nil,
  minimum_amount_currency: nil
)
  @currency_options = currency_options
  @first_time_transaction = first_time_transaction
  @minimum_amount = minimum_amount
  @minimum_amount_currency = minimum_amount_currency
end

Instance Attribute Details

#currency_options ⇒ Object

Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html) and a [supported currency](stripe.com/docs/currencies).



28
29
30
 
# File 'lib/stripe/params/promotion_code_create_params.rb', line 28

def currency_options
  @currency_options
end

#first_time_transaction ⇒ Object

A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices



30
31
32
 
# File 'lib/stripe/params/promotion_code_create_params.rb', line 30

def first_time_transaction
  @first_time_transaction
end

#minimum_amount ⇒ Object

Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).



32
33
34
 
# File 'lib/stripe/params/promotion_code_create_params.rb', line 32

def minimum_amount
  @minimum_amount
end

#minimum_amount_currency ⇒ Object

Three-letter [ISO code](stripe.com/docs/currencies) for minimum_amount



34
35
36
 
# File 'lib/stripe/params/promotion_code_create_params.rb', line 34

def minimum_amount_currency
  @minimum_amount_currency
end