Class: Stripe::PaymentLinkCreateParams::LineItem::PriceData

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

Defined Under Namespace

Classes: ProductData, Recurring

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #to_h

Constructor Details

#initialize(currency: nil, product: nil, product_data: nil, recurring: nil, tax_behavior: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ PriceData

Returns a new instance of PriceData.



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 417

def initialize(
  currency: nil,
  product: nil,
  product_data: nil,
  recurring: nil,
  tax_behavior: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @currency = currency
  @product = product
  @product_data = product_data
  @recurring = recurring
  @tax_behavior = tax_behavior
  @unit_amount = unit_amount
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#currency ⇒ Object

Three-letter ISO currency code, in lowercase. Must be a supported currency.



403
404
405
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 403

def currency
  @currency
end

#product ⇒ Object

The ID of the Product that this Price will belong to. One of product or product_data is required.



405
406
407
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 405

def product
  @product
end

#product_data ⇒ Object

Data used to generate a new Product object inline. One of product or product_data is required.



407
408
409
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 407

def product_data
  @product_data
end

#recurring ⇒ Object

The recurring components of a price such as interval and interval_count.



409
410
411
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 409

def recurring
  @recurring
end

#tax_behavior ⇒ Object

Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.



411
412
413
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 411

def tax_behavior
  @tax_behavior
end

#unit_amount ⇒ Object

A non-negative integer in cents (or local equivalent) representing how much to charge. One of unit_amount or unit_amount_decimal is required.



413
414
415
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 413

def unit_amount
  @unit_amount
end

#unit_amount_decimal ⇒ Object

Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.



415
416
417
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 415

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



435
436
437
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 435

def self.field_encodings
  @field_encodings = { unit_amount_decimal: :decimal_string }
end