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

Instance Method Summary collapse

Methods inherited from RequestParams

#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 



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 495

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



481
482
483
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 481

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.



483
484
485
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 483

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.



485
486
487
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 485

def product_data
  @product_data
end

#recurring ⇒ Object

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



487
488
489
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 487

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.



489
490
491
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 489

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.



491
492
493
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 491

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.



493
494
495
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 493

def unit_amount_decimal
  @unit_amount_decimal
end