stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/resources/credit_note_line_item.rb

@@ -2,7 +2,140 @@
 # frozen_string_literal: true
 
 module Stripe
+  # The credit note line item object
   class CreditNoteLineItem < StripeObject
     OBJECT_NAME = "credit_note_line_item"
+    def self.object_name
+      "credit_note_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 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 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
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Tax < ::Stripe::StripeObject
+      class TaxRateDetails < ::Stripe::StripeObject
+        # ID of the 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 integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
+    attr_reader :amount
+    # Description of the item being credited.
+    attr_reader :description
+    # The integer amount in cents (or local equivalent) representing the discount being credited for this line item.
+    attr_reader :discount_amount
+    # The amount of discount calculated per discount for this line item
+    attr_reader :discount_amounts
+    # Unique identifier for the object.
+    attr_reader :id
+    # ID of the invoice line item being credited
+    attr_reader :invoice_line_item
+    # 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
+    # The pretax credit amounts (ex: discount, credit grants, etc) for this line item.
+    attr_reader :pretax_credit_amounts
+    # The number of units of product being credited.
+    attr_reader :quantity
+    # The tax calculation identifiers of the line item.
+    attr_reader :tax_calculation_reference
+    # The tax rates which apply to the line item.
+    attr_reader :tax_rates
+    # The tax information of the line item.
+    attr_reader :taxes
+    # The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.
+    attr_reader :type
+    # The cost of each unit of product being credited.
+    attr_reader :unit_amount
+    # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
+    attr_reader :unit_amount_decimal
+
+    def self.inner_class_types
+      @inner_class_types = {
+        discount_amounts: DiscountAmount,
+        pretax_credit_amounts: PretaxCreditAmount,
+        tax_calculation_reference: TaxCalculationReference,
+        taxes: Tax,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/customer.rb

@@ -2,50 +2,400 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information,
+  # and track payments that belong to the same customer.
   class Customer < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::NestedResource
     extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
-    extend Stripe::APIOperations::NestedResource
 
     OBJECT_NAME = "customer"
+    def self.object_name
+      "customer"
+    end
+
+    nested_resource_class_methods :balance_transaction, operations: %i[create retrieve update list]
+    nested_resource_class_methods :cash_balance_transaction, operations: %i[retrieve list]
+    nested_resource_class_methods :source, operations: %i[create retrieve update delete list]
+    nested_resource_class_methods :tax_id, operations: %i[create retrieve delete list]
+
+    class Address < ::Stripe::StripeObject
+      # City, district, suburb, town, or village.
+      attr_reader :city
+      # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+      attr_reader :country
+      # Address line 1, such as the street, PO Box, or company name.
+      attr_reader :line1
+      # Address line 2, such as the apartment, suite, unit, or building.
+      attr_reader :line2
+      # ZIP or postal code.
+      attr_reader :postal_code
+      # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
+      attr_reader :state
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
 
-    custom_method :create_funding_instructions, http_verb: :post, http_path: "funding_instructions"
-    custom_method :list_payment_methods, http_verb: :get, http_path: "payment_methods"
+    class InvoiceSettings < ::Stripe::StripeObject
+      class CustomField < ::Stripe::StripeObject
+        # The name of the custom field.
+        attr_reader :name
+        # The value of the custom field.
+        attr_reader :value
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class RenderingOptions < ::Stripe::StripeObject
+        # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
+        attr_reader :amount_tax_display
+        # ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.
+        attr_reader :template
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Default custom fields to be displayed on invoices for this customer.
+      attr_reader :custom_fields
+      # ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
+      attr_reader :default_payment_method
+      # Default footer to be displayed on invoices for this customer.
+      attr_reader :footer
+      # Default options for invoice PDF rendering for this customer.
+      attr_reader :rendering_options
+
+      def self.inner_class_types
+        @inner_class_types = { custom_fields: CustomField, rendering_options: RenderingOptions }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
 
-    nested_resource_class_methods :cash_balance,
-                                  operations: %i[retrieve update],
-                                  resource_plural: "cash_balance"
-    nested_resource_class_methods :balance_transaction,
-                                  operations: %i[create retrieve update list]
-    nested_resource_class_methods :tax_id,
-                                  operations: %i[create retrieve delete list]
+    class Shipping < ::Stripe::StripeObject
+      class Address < ::Stripe::StripeObject
+        # City, district, suburb, town, or village.
+        attr_reader :city
+        # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+        attr_reader :country
+        # Address line 1, such as the street, PO Box, or company name.
+        attr_reader :line1
+        # Address line 2, such as the apartment, suite, unit, or building.
+        attr_reader :line2
+        # ZIP or postal code.
+        attr_reader :postal_code
+        # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
+        attr_reader :state
 
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field address
+      attr_reader :address
+      # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
+      attr_reader :carrier
+      # Recipient name.
+      attr_reader :name
+      # Recipient phone (including extension).
+      attr_reader :phone
+      # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
+      attr_reader :tracking_number
+
+      def self.inner_class_types
+        @inner_class_types = { address: Address }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Tax < ::Stripe::StripeObject
+      class Location < ::Stripe::StripeObject
+        # The identified tax country of the customer.
+        attr_reader :country
+        # The data source used to infer the customer's location.
+        attr_reader :source
+        # The identified tax state, county, province, or region of the customer.
+        attr_reader :state
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Surfaces if automatic tax computation is possible given the current customer location information.
+      attr_reader :automatic_tax
+      # A recent IP address of the customer used for tax reporting and tax location inference.
+      attr_reader :ip_address
+      # The identified tax location of the customer.
+      attr_reader :location
+      # The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps).
+      attr_reader :provider
+
+      def self.inner_class_types
+        @inner_class_types = { location: Location }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The customer's address.
+    attr_reader :address
+    # The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance).
+    attr_reader :balance
+    # The customer's business name.
+    attr_reader :business_name
+    # The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.
+    attr_reader :cash_balance
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.
+    attr_reader :currency
+    # The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.
+    attr_reader :customer_account
+    # ID of the default payment source for the customer.
+    #
+    # If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.
+    attr_reader :default_source
+    # Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.
+    #
+    # If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`.
+    #
+    # If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.
+    attr_reader :delinquent
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # Describes the current discount active on the customer, if there is one.
+    attr_reader :discount
+    # The customer's email address.
+    attr_reader :email
+    # Unique identifier for the object.
+    attr_reader :id
+    # The customer's individual name.
+    attr_reader :individual_name
+    # The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.
+    attr_reader :invoice_credit_balance
+    # The prefix for the customer used to generate unique invoice numbers.
+    attr_reader :invoice_prefix
+    # Attribute for field invoice_settings
+    attr_reader :invoice_settings
+    # 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://docs.stripe.com/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 customer's full name or business name.
+    attr_reader :name
+    # The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.
+    attr_reader :next_invoice_sequence
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The customer's phone number.
+    attr_reader :phone
+    # The customer's preferred locales (languages), ordered by preference.
+    attr_reader :preferred_locales
+    # Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
+    attr_reader :shipping
+    # The customer's payment sources, if any.
+    attr_reader :sources
+    # The customer's current subscriptions, if any.
+    attr_reader :subscriptions
+    # Attribute for field tax
+    attr_reader :tax
+    # Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**.
+    attr_reader :tax_exempt
+    # The customer's tax IDs.
+    attr_reader :tax_ids
+    # ID of the test clock that this customer belongs to.
+    attr_reader :test_clock
+    # Always true for a deleted object
+    attr_reader :deleted
+
+    # Creates a new customer object.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/customers", params: params, opts: opts)
+    end
+
+    # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
+    # funding instructions will be created. If funding instructions have already been created for a given customer, the same
+    # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
     def create_funding_instructions(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/funding_instructions",
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
+    # funding instructions will be created. If funding instructions have already been created for a given customer, the same
+    # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
+    def self.create_funding_instructions(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
+    def self.delete(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Removes the currently applied discount on a customer.
+    def delete_discount(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/discount", { customer: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Removes the currently applied discount on a customer.
+    def self.delete_discount(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/discount", { customer: CGI.escape(customer) }),
         params: params,
         opts: opts
       )
     end
 
+    # Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/customers", params: params, opts: opts)
+    end
+
+    # Returns a list of PaymentMethods for a given Customer
     def list_payment_methods(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: resource_url + "/payment_methods",
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Returns a list of PaymentMethods for a given Customer
+    def self.list_payment_methods(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(customer) }),
         params: params,
         opts: opts
       )
     end
 
-    custom_method :delete_discount, http_verb: :delete, http_path: "discount"
+    # Retrieves a customer's cash balance.
+    def self.retrieve_cash_balance(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Retrieves a PaymentMethod object for a given Customer.
+    def retrieve_payment_method(payment_method, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(self["id"]), payment_method: CGI.escape(payment_method) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Retrieves a PaymentMethod object for a given Customer.
+    def self.retrieve_payment_method(customer, payment_method, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(customer), payment_method: CGI.escape(payment_method) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.search(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/customers/search", params: params, opts: opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
+
+    # Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer's active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer's current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
+    #
+    # This request accepts mostly the same arguments as the customer creation call.
+    def self.update(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Changes the settings on a customer's cash balance.
+    def self.update_cash_balance(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
 
     save_nested_resource :source
-    nested_resource_class_methods :source,
-                                  operations: %i[create retrieve update delete list]
 
     # The API request for deleting a card or bank account and for detaching a
     # source object are the same.
@@ -53,22 +403,48 @@ module Stripe
       alias detach_source delete_source
     end
 
-    # Deletes a discount associated with the customer.
-    #
-    # Returns the deleted discount. The customer object is not updated,
-    # so you must call `refresh` on it to get a new version with the
-    # discount removed.
-    def delete_discount
-      resp, opts = execute_resource_request(:delete, resource_url + "/discount")
-      Util.convert_to_stripe_object(resp.data, opts)
+    def test_helpers
+      TestHelpers.new(self)
     end
 
-    def self.search(params = {}, opts = {})
-      _search("/v1/customers/search", params, opts)
+    class TestHelpers < APIResourceTestHelpers
+      RESOURCE_CLASS = Customer
+      def self.resource_class
+        "Customer"
+      end
+
+      # Create an incoming testmode bank transfer
+      def self.fund_cash_balance(customer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/customers/%<customer>s/fund_cash_balance", { customer: CGI.escape(customer) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Create an incoming testmode bank transfer
+      def fund_cash_balance(params = {}, opts = {})
+        @resource.request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/customers/%<customer>s/fund_cash_balance", { customer: CGI.escape(@resource["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
 
-    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
-      search(params, opts).auto_paging_each(&blk)
+    def self.inner_class_types
+      @inner_class_types = {
+        address: Address,
+        invoice_settings: InvoiceSettings,
+        shipping: Shipping,
+        tax: Tax,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
     end
   end
 end

data/lib/stripe/resources/customer_balance_transaction.rb

@@ -2,11 +2,50 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Each customer has a [Balance](https://docs.stripe.com/api/customers/object#customer_object-balance) value,
+  # which denotes a debit or credit that's automatically applied to their next invoice upon finalization.
+  # You may modify the value directly by using the [update customer API](https://docs.stripe.com/api/customers/update),
+  # or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.
+  #
+  # Related guide: [Customer balance](https://docs.stripe.com/billing/customer/balance)
   class CustomerBalanceTransaction < APIResource
-    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "customer_balance_transaction"
+    def self.object_name
+      "customer_balance_transaction"
+    end
+
+    # The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.
+    attr_reader :amount
+    # The ID of the checkout session (if any) that created the transaction.
+    attr_reader :checkout_session
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # The ID of the credit note (if any) related to the transaction.
+    attr_reader :credit_note
+    # 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 the transaction belongs to.
+    attr_reader :customer
+    # The ID of an Account representing a customer that the transaction belongs to.
+    attr_reader :customer_account
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.
+    attr_reader :ending_balance
+    # Unique identifier for the object.
+    attr_reader :id
+    # The ID of the invoice (if any) related to the transaction.
+    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://docs.stripe.com/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
+    # Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://docs.stripe.com/billing/customer/balance#types) to learn more about transaction types.
+    attr_reader :type
 
     def resource_url
       if !respond_to?(:customer) || customer.nil?
@@ -27,5 +66,13 @@ module Stripe
             "Customer Balance Transactions cannot be retrieved without a customer ID. " \
             "Update a Customer Balance Transaction using `Customer.update_balance_transaction('cus_123', 'cbtxn_123', params)`"
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end