stripe 13.4.1 → 17.0.1

data/lib/stripe/resources/invoice_item.rb

@@ -2,10 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  # Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). An invoice item is added to an
-  # invoice by creating or updating it with an `invoice` field, at which point it will be included as
-  # [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within
-  # [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).
+  # Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).
   #
   # Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined
   # with a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge
@@ -24,6 +21,152 @@ module Stripe
       "invoiceitem"
     end
 
+    class Parent < Stripe::StripeObject
+      class SubscriptionDetails < Stripe::StripeObject
+        # The subscription that generated this invoice item
+        attr_reader :subscription
+        # The subscription item that generated this invoice item
+        attr_reader :subscription_item
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Details about the subscription that generated this invoice item
+      attr_reader :subscription_details
+      # The type of parent that generated this invoice item
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { subscription_details: SubscriptionDetails }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Period < Stripe::StripeObject
+      # The end of the period, which must be greater than or equal to the start. This value is inclusive.
+      attr_reader :end
+      # The start of the period. This value is inclusive.
+      attr_reader :start
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Pricing < Stripe::StripeObject
+      class PriceDetails < Stripe::StripeObject
+        # The ID of the price this item is associated with.
+        attr_reader :price
+        # The ID of the product this item is associated with.
+        attr_reader :product
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field price_details
+      attr_reader :price_details
+      # The type of the pricing details.
+      attr_reader :type
+      # The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
+      attr_reader :unit_amount_decimal
+
+      def self.inner_class_types
+        @inner_class_types = { price_details: PriceDetails }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class ProrationDetails < Stripe::StripeObject
+      class DiscountAmount < Stripe::StripeObject
+        # The amount, in cents (or local equivalent), of the discount.
+        attr_reader :amount
+        # The discount that was applied to get this discount amount.
+        attr_reader :discount
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Discount amounts applied when the proration was created.
+      attr_reader :discount_amounts
+
+      def self.inner_class_types
+        @inner_class_types = { discount_amounts: DiscountAmount }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.
+    attr_reader :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_reader :currency
+    # The ID of the customer who will be billed when this invoice item is billed.
+    attr_reader :customer
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :date
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # If true, discounts will apply to this invoice item. Always false for prorations.
+    attr_reader :discountable
+    # The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
+    attr_reader :discounts
+    # Unique identifier for the object.
+    attr_reader :id
+    # The ID of the invoice this invoice item belongs to.
+    attr_reader :invoice
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # 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
+    # The amount after discounts, but before credits and taxes. This field is `null` for `discountable=true` items.
+    attr_reader :net_amount
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The parent that generated this invoice item.
+    attr_reader :parent
+    # Attribute for field period
+    attr_reader :period
+    # The pricing information of the invoice item.
+    attr_reader :pricing
+    # Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
+    attr_reader :proration
+    # Attribute for field proration_details
+    attr_reader :proration_details
+    # Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
+    attr_reader :quantity
+    # 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_reader :tax_rates
+    # ID of the test clock this invoice item belongs to.
+    attr_reader :test_clock
+    # Always true for a deleted object
+    attr_reader :deleted
+
     # Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/invoiceitems", params: params, opts: opts)
@@ -63,5 +206,18 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = {
+        parent: Parent,
+        period: Period,
+        pricing: Pricing,
+        proration_details: ProrationDetails,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/invoice_line_item.rb

@@ -5,7 +5,7 @@ module Stripe
   # Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.
   #
   # Each line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).
-  class InvoiceLineItem < StripeObject
+  class InvoiceLineItem < APIResource
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "line_item"
@@ -13,6 +13,268 @@ module Stripe
       "line_item"
     end
 
+    class DiscountAmount < Stripe::StripeObject
+      # The amount, in cents (or local equivalent), of the discount.
+      attr_reader :amount
+      # The discount that was applied to get this discount amount.
+      attr_reader :discount
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Parent < Stripe::StripeObject
+      class InvoiceItemDetails < Stripe::StripeObject
+        class ProrationDetails < Stripe::StripeObject
+          class CreditedItems < Stripe::StripeObject
+            # Invoice containing the credited invoice line items
+            attr_reader :invoice
+            # Credited invoice line items
+            attr_reader :invoice_line_items
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
+          attr_reader :credited_items
+
+          def self.inner_class_types
+            @inner_class_types = { credited_items: CreditedItems }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The invoice item that generated this line item
+        attr_reader :invoice_item
+        # Whether this is a proration
+        attr_reader :proration
+        # Additional details for proration line items
+        attr_reader :proration_details
+        # The subscription that the invoice item belongs to
+        attr_reader :subscription
+
+        def self.inner_class_types
+          @inner_class_types = { proration_details: ProrationDetails }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class SubscriptionItemDetails < Stripe::StripeObject
+        class ProrationDetails < Stripe::StripeObject
+          class CreditedItems < Stripe::StripeObject
+            # Invoice containing the credited invoice line items
+            attr_reader :invoice
+            # Credited invoice line items
+            attr_reader :invoice_line_items
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
+          attr_reader :credited_items
+
+          def self.inner_class_types
+            @inner_class_types = { credited_items: CreditedItems }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The invoice item that generated this line item
+        attr_reader :invoice_item
+        # Whether this is a proration
+        attr_reader :proration
+        # Additional details for proration line items
+        attr_reader :proration_details
+        # The subscription that the subscription item belongs to
+        attr_reader :subscription
+        # The subscription item that generated this line item
+        attr_reader :subscription_item
+
+        def self.inner_class_types
+          @inner_class_types = { proration_details: ProrationDetails }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Details about the invoice item that generated this line item
+      attr_reader :invoice_item_details
+      # Details about the subscription item that generated this line item
+      attr_reader :subscription_item_details
+      # The type of parent that generated this line item
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {
+          invoice_item_details: InvoiceItemDetails,
+          subscription_item_details: SubscriptionItemDetails,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Period < Stripe::StripeObject
+      # The end of the period, which must be greater than or equal to the start. This value is inclusive.
+      attr_reader :end
+      # The start of the period. This value is inclusive.
+      attr_reader :start
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class PretaxCreditAmount < Stripe::StripeObject
+      # The amount, in cents (or local equivalent), of the pretax credit amount.
+      attr_reader :amount
+      # The credit balance transaction that was applied to get this pretax credit amount.
+      attr_reader :credit_balance_transaction
+      # The discount that was applied to get this pretax credit amount.
+      attr_reader :discount
+      # Type of the pretax credit amount referenced.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Pricing < Stripe::StripeObject
+      class PriceDetails < Stripe::StripeObject
+        # The ID of the price this item is associated with.
+        attr_reader :price
+        # The ID of the product this item is associated with.
+        attr_reader :product
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field price_details
+      attr_reader :price_details
+      # The type of the pricing details.
+      attr_reader :type
+      # The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
+      attr_reader :unit_amount_decimal
+
+      def self.inner_class_types
+        @inner_class_types = { price_details: PriceDetails }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Tax < Stripe::StripeObject
+      class TaxRateDetails < Stripe::StripeObject
+        # Attribute for field tax_rate
+        attr_reader :tax_rate
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The amount of the tax, in cents (or local equivalent).
+      attr_reader :amount
+      # Whether this tax is inclusive or exclusive.
+      attr_reader :tax_behavior
+      # Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
+      attr_reader :tax_rate_details
+      # 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
+      # The type of tax information.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { tax_rate_details: TaxRateDetails }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The amount, in cents (or local equivalent).
+    attr_reader :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_reader :currency
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # The amount of discount calculated per discount for this line item.
+    attr_reader :discount_amounts
+    # If true, discounts will apply to this line item. Always false for prorations.
+    attr_reader :discountable
+    # The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
+    attr_reader :discounts
+    # Unique identifier for the object.
+    attr_reader :id
+    # The ID of the invoice that contains this line item.
+    attr_reader :invoice
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # 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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The parent that generated this line item.
+    attr_reader :parent
+    # Attribute for field period
+    attr_reader :period
+    # Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.
+    attr_reader :pretax_credit_amounts
+    # The pricing information of the line item.
+    attr_reader :pricing
+    # The quantity of the subscription, if the line item is a subscription or a proration.
+    attr_reader :quantity
+    # Attribute for field subscription
+    attr_reader :subscription
+    # The tax information of the line item.
+    attr_reader :taxes
+
     # Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item,
     # so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
     # item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
@@ -25,5 +287,20 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = {
+        discount_amounts: DiscountAmount,
+        parent: Parent,
+        period: Period,
+        pretax_credit_amounts: PretaxCreditAmount,
+        pricing: Pricing,
+        taxes: Tax,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/invoice_payment.rb

@@ -0,0 +1,90 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Invoice Payments represent payments made against invoices. Invoice Payments can
+  # be accessed in two ways:
+  # 1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource.
+  # 2. By using the Invoice Payment retrieve and list endpoints.
+  #
+  # Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.
+  # This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and
+  # monitor the allocation details of the payments.
+  class InvoicePayment < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "invoice_payment"
+    def self.object_name
+      "invoice_payment"
+    end
+
+    class Payment < Stripe::StripeObject
+      # ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.
+      attr_reader :charge
+      # ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
+      attr_reader :payment_intent
+      # Type of payment object associated with this invoice payment.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class StatusTransitions < Stripe::StripeObject
+      # The time that the payment was canceled.
+      attr_reader :canceled_at
+      # The time that the payment succeeded.
+      attr_reader :paid_at
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to.
+    attr_reader :amount_paid
+    # Amount intended to be paid toward this invoice, in cents (or local equivalent)
+    attr_reader :amount_requested
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # 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
+    # Unique identifier for the object.
+    attr_reader :id
+    # The invoice that was paid.
+    attr_reader :invoice
+    # Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s `amount_remaining`. The PaymentIntent associated with the default payment can’t be edited or canceled directly.
+    attr_reader :is_default
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Attribute for field payment
+    attr_reader :payment
+    # The status of the payment, one of `open`, `paid`, or `canceled`.
+    attr_reader :status
+    # Attribute for field status_transitions
+    attr_reader :status_transitions
+
+    # When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/invoice_payments", params: params, opts: opts)
+    end
+
+    def self.inner_class_types
+      @inner_class_types = { payment: Payment, status_transitions: StatusTransitions }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/invoice_rendering_template.rb

@@ -12,6 +12,23 @@ module Stripe
       "invoice_rendering_template"
     end
 
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Unique identifier for the object.
+    attr_reader :id
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # 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
+    # A brief description of the template, hidden from customers
+    attr_reader :nickname
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The status of the template, one of `active` or `archived`.
+    attr_reader :status
+    # Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering
+    attr_reader :version
+
     # Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
     def archive(params = {}, opts = {})
       request_stripe_object(
@@ -61,5 +78,13 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end