Class: Stripe::Coupon::UpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/coupon.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, expand: nil, metadata: nil, name: nil) ⇒ UpdateParams

Returns a new instance of UpdateParams.



50
51
52
53
54
55
 
# File 'lib/stripe/resources/coupon.rb', line 50

def initialize(currency_options: nil, expand: nil, metadata: nil, name: nil)
  @currency_options = currency_options
  @expand = expand
  @metadata = metadata
  @name = name
end

Instance Attribute Details

#currency_options ⇒ Object

Coupons defined in each available currency option (only supported if the coupon is amount-based). 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).



42
43
44
 
# File 'lib/stripe/resources/coupon.rb', line 42

def currency_options
  @currency_options
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



44
45
46
 
# File 'lib/stripe/resources/coupon.rb', line 44

def expand
  @expand
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



46
47
48
 
# File 'lib/stripe/resources/coupon.rb', line 46

def metadata
  @metadata
end

#name ⇒ Object

Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the ‘id` is shown if `name` is not set.



48
49
50
 
# File 'lib/stripe/resources/coupon.rb', line 48

def name
  @name
end