Class: Stripe::Climate::OrderCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/climate/order_create_params.rb

Defined Under Namespace

Classes: Beneficiary

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, beneficiary: nil, currency: nil, expand: nil, metadata: nil, metric_tons: nil, product: nil) ⇒ OrderCreateParams

Returns a new instance of OrderCreateParams.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/stripe/params/climate/order_create_params.rb', line 30

def initialize(
  amount: nil,
  beneficiary: nil,
  currency: nil,
  expand: nil,
  metadata: nil,
  metric_tons: nil,
  product: nil
)
  @amount = amount
  @beneficiary = beneficiary
  @currency = currency
  @expand = expand
  @metadata = metadata
  @metric_tons = metric_tons
  @product = product
end

Instance Attribute Details

#amount ⇒ Object

Requested amount of carbon removal units. Either this or ‘metric_tons` must be specified.



16
17
18
 
# File 'lib/stripe/params/climate/order_create_params.rb', line 16

def amount
  @amount
end

#beneficiary ⇒ Object

Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.



18
19
20
 
# File 'lib/stripe/params/climate/order_create_params.rb', line 18

def beneficiary
  @beneficiary
end

#currency ⇒ Object

Request currency for the order as a three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](stripe.com/docs/currencies). If omitted, the account’s default currency will be used.



20
21
22
 
# File 'lib/stripe/params/climate/order_create_params.rb', line 20

def currency
  @currency
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



22
23
24
 
# File 'lib/stripe/params/climate/order_create_params.rb', line 22

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`.



24
25
26
 
# File 'lib/stripe/params/climate/order_create_params.rb', line 24

def metadata
  @metadata
end

#metric_tons ⇒ Object

Requested number of tons for the order. Either this or ‘amount` must be specified.



26
27
28
 
# File 'lib/stripe/params/climate/order_create_params.rb', line 26

def metric_tons
  @metric_tons
end

#product ⇒ Object

Unique identifier of the Climate product.



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

def product
  @product
end