mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-06-03 00:01:47 -04:00
97 lines
3.9 KiB
Ruby
97 lines
3.9 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
# A line item.
|
|
class LineItem < APIResource
|
|
OBJECT_NAME = "item"
|
|
def self.object_name
|
|
"item"
|
|
end
|
|
|
|
class AdjustableQuantity < Stripe::StripeObject
|
|
# Attribute for field enabled
|
|
attr_reader :enabled
|
|
# Attribute for field maximum
|
|
attr_reader :maximum
|
|
# Attribute for field minimum
|
|
attr_reader :minimum
|
|
end
|
|
|
|
class Discount < Stripe::StripeObject
|
|
# The amount discounted.
|
|
attr_reader :amount
|
|
# A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
|
|
# It contains information about when the discount began, when it will end, and what it is applied to.
|
|
#
|
|
# Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
|
|
attr_reader :discount
|
|
end
|
|
|
|
class Display < Stripe::StripeObject
|
|
# Attribute for field description
|
|
attr_reader :description
|
|
# Attribute for field images
|
|
attr_reader :images
|
|
# Attribute for field name
|
|
attr_reader :name
|
|
end
|
|
|
|
class TaxCalculationReference < Stripe::StripeObject
|
|
# The calculation identifier for tax calculation response.
|
|
attr_reader :calculation_id
|
|
# The calculation identifier for tax calculation response line item.
|
|
attr_reader :calculation_item_id
|
|
end
|
|
|
|
class Tax < Stripe::StripeObject
|
|
# Amount of tax applied for this rate.
|
|
attr_reader :amount
|
|
# Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
|
|
#
|
|
# Related guide: [Tax rates](/billing/taxes/tax-rates)
|
|
attr_reader :rate
|
|
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
|
|
attr_reader :taxability_reason
|
|
# The amount on which tax is calculated, in cents (or local equivalent).
|
|
attr_reader :taxable_amount
|
|
end
|
|
# Attribute for field adjustable_quantity
|
|
attr_reader :adjustable_quantity
|
|
# Total discount amount applied. If no discounts were applied, defaults to 0.
|
|
attr_reader :amount_discount
|
|
# Total before any discounts or taxes are applied.
|
|
attr_reader :amount_subtotal
|
|
# Total tax amount applied. If no tax was applied, defaults to 0.
|
|
attr_reader :amount_tax
|
|
# Total after discounts and taxes.
|
|
attr_reader :amount_total
|
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
attr_reader :currency
|
|
# An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
|
|
attr_reader :description
|
|
# The discounts applied to the line item.
|
|
attr_reader :discounts
|
|
# Attribute for field display
|
|
attr_reader :display
|
|
# Unique identifier for the object.
|
|
attr_reader :id
|
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
attr_reader :metadata
|
|
# String representing the object's type. Objects of the same type share the same value.
|
|
attr_reader :object
|
|
# The price used to generate the line item.
|
|
attr_reader :price
|
|
# The ID of the product for this line item.
|
|
#
|
|
# This will always be the same as `price.product`.
|
|
attr_reader :product
|
|
# The quantity of products being purchased.
|
|
attr_reader :quantity
|
|
# The tax calculation identifiers of the line item.
|
|
attr_reader :tax_calculation_reference
|
|
# The taxes applied to the line item.
|
|
attr_reader :taxes
|
|
end
|
|
end
|