stripe-ruby/lib/stripe/params/invoice_item_create_params.rb

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  class InvoiceItemCreateParams < Stripe::RequestParams
    class Discount < Stripe::RequestParams
      class DiscountEnd < Stripe::RequestParams
        class Duration < Stripe::RequestParams
          # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
          attr_accessor :interval
          # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
          attr_accessor :interval_count

          def initialize(interval: nil, interval_count: nil)
            @interval = interval
            @interval_count = interval_count
          end
        end
        # Time span for the redeemed discount.
        attr_accessor :duration
        # A precise Unix timestamp for the discount to end. Must be in the future.
        attr_accessor :timestamp
        # The type of calculation made to determine when the discount ends.
        attr_accessor :type

        def initialize(duration: nil, timestamp: nil, type: nil)
          @duration = duration
          @timestamp = timestamp
          @type = type
        end
      end
      # ID of the coupon to create a new discount for.
      attr_accessor :coupon
      # ID of an existing discount on the object (or one of its ancestors) to reuse.
      attr_accessor :discount
      # Details to determine how long the discount should be applied for.
      attr_accessor :discount_end
      # ID of the promotion code to create a new discount for.
      attr_accessor :promotion_code

      def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
        @coupon = coupon
        @discount = discount
        @discount_end = discount_end
        @promotion_code = promotion_code
      end
    end

    class Period < Stripe::RequestParams
      # The end of the period, which must be greater than or equal to the start. This value is inclusive.
      attr_accessor :end
      # The start of the period. This value is inclusive.
      attr_accessor :start

      def initialize(end_: nil, start: nil)
        @end = end_
        @start = start
      end
    end

    class PriceData < Stripe::RequestParams
      # 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_accessor :currency
      # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
      attr_accessor :product
      # Only required if a [default tax behavior](https://stripe.com/docs/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.
      attr_accessor :tax_behavior
      # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
      attr_accessor :unit_amount
      # 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.
      attr_accessor :unit_amount_decimal

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

    class Pricing < Stripe::RequestParams
      # The ID of the price object.
      attr_accessor :price

      def initialize(price: nil)
        @price = price
      end
    end
    # The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.
    attr_accessor :amount
    # 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_accessor :currency
    # The ID of the customer who will be billed when this invoice item is billed.
    attr_accessor :customer
    # The ID of the account who will be billed when this invoice item is billed.
    attr_accessor :customer_account
    # An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
    attr_accessor :description
    # Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.
    attr_accessor :discountable
    # The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item.
    attr_accessor :discounts
    # Specifies which fields in the response should be expanded.
    attr_accessor :expand
    # The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
    attr_accessor :invoice
    # The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
    attr_accessor :margins
    # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
    attr_accessor :metadata
    # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
    attr_accessor :period
    # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
    attr_accessor :price_data
    # The pricing information for the invoice item.
    attr_accessor :pricing
    # Non-negative integer. The quantity of units for the invoice item.
    attr_accessor :quantity
    # The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    attr_accessor :subscription
    # Only required if a [default tax behavior](https://stripe.com/docs/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.
    attr_accessor :tax_behavior
    # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
    attr_accessor :tax_code
    # The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
    attr_accessor :tax_rates
    # The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.
    attr_accessor :unit_amount_decimal

    def initialize(
      amount: nil,
      currency: nil,
      customer: nil,
      customer_account: nil,
      description: nil,
      discountable: nil,
      discounts: nil,
      expand: nil,
      invoice: nil,
      margins: nil,
      metadata: nil,
      period: nil,
      price_data: nil,
      pricing: nil,
      quantity: nil,
      subscription: nil,
      tax_behavior: nil,
      tax_code: nil,
      tax_rates: nil,
      unit_amount_decimal: nil
    )
      @amount = amount
      @currency = currency
      @customer = customer
      @customer_account = customer_account
      @description = description
      @discountable = discountable
      @discounts = discounts
      @expand = expand
      @invoice = invoice
      @margins = margins
      @metadata = metadata
      @period = period
      @price_data = price_data
      @pricing = pricing
      @quantity = quantity
      @subscription = subscription
      @tax_behavior = tax_behavior
      @tax_code = tax_code
      @tax_rates = tax_rates
      @unit_amount_decimal = unit_amount_decimal
    end
  end
end