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

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

Returns a new instance of PriceData.



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# File 'lib/stripe/params/payment_link_create_params.rb', line 402

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

#currencyObject

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



388
389
390
# File 'lib/stripe/params/payment_link_create_params.rb', line 388

def currency
  @currency
end

#productObject

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.



390
391
392
# File 'lib/stripe/params/payment_link_create_params.rb', line 390

def product
  @product
end

#product_dataObject

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



392
393
394
# File 'lib/stripe/params/payment_link_create_params.rb', line 392

def product_data
  @product_data
end

#recurringObject

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



394
395
396
# File 'lib/stripe/params/payment_link_create_params.rb', line 394

def recurring
  @recurring
end

#tax_behaviorObject

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.



396
397
398
# File 'lib/stripe/params/payment_link_create_params.rb', line 396

def tax_behavior
  @tax_behavior
end

#unit_amountObject

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



398
399
400
# File 'lib/stripe/params/payment_link_create_params.rb', line 398

def unit_amount
  @unit_amount
end

#unit_amount_decimalObject

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.



400
401
402
# File 'lib/stripe/params/payment_link_create_params.rb', line 400

def unit_amount_decimal
  @unit_amount_decimal
end