Class: Stripe::Checkout::SessionCreateParams::LineItem::PriceData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/checkout/session_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.



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 543

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](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



529
530
531
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 529

def currency
  @currency
end

#product ⇒ Object

The ID of the [Product](docs.stripe.com/api/products) that this [Price](docs.stripe.com/api/prices) will belong to. One of ‘product` or `product_data` is required.



531
532
533
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 531

def product
  @product
end

#product_data ⇒ Object

Data used to generate a new [Product](docs.stripe.com/api/products) object inline. One of ‘product` or `product_data` is required.



533
534
535
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 533

def product_data
  @product_data
end

#recurring ⇒ Object

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



535
536
537
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 535

def recurring
  @recurring
end

#tax_behavior ⇒ Object

Only required if a [default tax behavior](docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) 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.



537
538
539
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 537

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.



539
540
541
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 539

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.



541
542
543
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 541

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



561
562
563
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 561

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