Class: Stripe::PaymentIntentCreateParams::AmountDetails

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

Defined Under Namespace

Classes: LineItem, Shipping, Tax

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(discount_amount: nil, enforce_arithmetic_validation: nil, line_items: nil, shipping: nil, tax: nil) ⇒ AmountDetails

Returns a new instance of AmountDetails.



175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 175

def initialize(
  discount_amount: nil,
  enforce_arithmetic_validation: nil,
  line_items: nil,
  shipping: nil,
  tax: nil
)
  @discount_amount = discount_amount
  @enforce_arithmetic_validation = enforce_arithmetic_validation
  @line_items = line_items
  @shipping = shipping
  @tax = tax
end

Instance Attribute Details

#discount_amount ⇒ Object

The total discount applied on the transaction represented in the [smallest currency unit](docs.stripe.com/currencies#zero-decimal). An integer greater than 0.

This field is mutually exclusive with the ‘amount_details[#][discount_amount]` field.



161
162
163
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 161

def discount_amount
  @discount_amount
end

#enforce_arithmetic_validation ⇒ Object

Set to false to return arithmetic validation errors in the response without failing the request. Use this when you want the operation to proceed regardless of arithmetic errors in the line item data.

Omit or set to true to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies.

For card payments, Stripe doesn’t send line item data if there’s an arithmetic validation error to card networks.



167
168
169
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 167

def enforce_arithmetic_validation
  @enforce_arithmetic_validation
end

#line_items ⇒ Object

A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items.



169
170
171
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 169

def line_items
  @line_items
end

#shipping ⇒ Object

Contains information about the shipping portion of the amount.



171
172
173
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 171

def shipping
  @shipping
end

#tax ⇒ Object

Contains information about the tax portion of the amount.



173
174
175
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 173

def tax
  @tax
end