stripe 13.6.0.pre.beta.1 → 14.0.0

data/rbi/stripe/resources/credit_note.rbi

@@ -70,22 +70,30 @@ module Stripe
       sig { returns(T::Array[Tax]) }
       attr_reader :taxes
     end
-    class TaxAmount < Stripe::StripeObject
-      # The amount, in cents (or local equivalent), of the tax.
+    class TotalTax < Stripe::StripeObject
+      class TaxRateDetails < Stripe::StripeObject
+        # Attribute for field tax_rate
+        sig { returns(String) }
+        attr_reader :tax_rate
+      end
+      # The amount of the tax, in cents (or local equivalent).
       sig { returns(Integer) }
       attr_reader :amount
-      # Whether this tax amount is inclusive or exclusive.
-      sig { returns(T::Boolean) }
-      attr_reader :inclusive
-      # The tax rate that was applied to get this tax amount.
-      sig { returns(T.any(String, Stripe::TaxRate)) }
-      attr_reader :tax_rate
+      # Whether this tax is inclusive or exclusive.
+      sig { returns(String) }
+      attr_reader :tax_behavior
+      # Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
+      sig { returns(T.nilable(TaxRateDetails)) }
+      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.
-      sig { returns(T.nilable(String)) }
+      sig { returns(String) }
       attr_reader :taxability_reason
       # The amount on which tax is calculated, in cents (or local equivalent).
       sig { returns(T.nilable(Integer)) }
       attr_reader :taxable_amount
+      # The type of tax information.
+      sig { returns(String) }
+      attr_reader :type
     end
     # The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
     sig { returns(Integer) }
@@ -144,21 +152,12 @@ module Stripe
     # The link to download the PDF of the credit note.
     sig { returns(String) }
     attr_reader :pdf
-    # Attribute for field post_payment_amount
-    sig { returns(Integer) }
-    attr_reader :post_payment_amount
-    # Attribute for field pre_payment_amount
-    sig { returns(Integer) }
-    attr_reader :pre_payment_amount
     # The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
     sig { returns(T::Array[PretaxCreditAmount]) }
     attr_reader :pretax_credit_amounts
     # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
     sig { returns(T.nilable(String)) }
     attr_reader :reason
-    # Refund related to this credit note.
-    sig { returns(T.nilable(T.any(String, Stripe::Refund))) }
-    attr_reader :refund
     # Refunds related to this credit note.
     sig { returns(T::Array[Refund]) }
     attr_reader :refunds
@@ -174,15 +173,15 @@ module Stripe
     # The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
     sig { returns(T.nilable(Integer)) }
     attr_reader :subtotal_excluding_tax
-    # The aggregate amounts calculated per tax rate for all line items.
-    sig { returns(T::Array[TaxAmount]) }
-    attr_reader :tax_amounts
     # The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
     sig { returns(Integer) }
     attr_reader :total
     # The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
     sig { returns(T.nilable(Integer)) }
     attr_reader :total_excluding_tax
+    # The aggregate tax information for all line items.
+    sig { returns(T.nilable(T::Array[TotalTax])) }
+    attr_reader :total_taxes
     # Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.
     sig { returns(String) }
     attr_reader :type
@@ -192,43 +191,45 @@ module Stripe
     class ListParams < Stripe::RequestParams
       class Created < Stripe::RequestParams
         # Minimum value to filter by (exclusive)
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :gt
         # Minimum value to filter by (inclusive)
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :gte
         # Maximum value to filter by (exclusive)
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :lt
         # Maximum value to filter by (inclusive)
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :lte
-        sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+        sig {
+          params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
+         }
         def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
       end
       # Only return credit notes that were created during the given date interval.
-      sig { returns(T.any(::Stripe::CreditNote::ListParams::Created, Integer)) }
+      sig { returns(T.nilable(T.any(::Stripe::CreditNote::ListParams::Created, Integer))) }
       attr_accessor :created
       # Only return credit notes for the customer specified by this customer ID.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :customer
       # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :ending_before
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
       # Only return credit notes for the invoice specified by this invoice ID.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :invoice
       # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :limit
       # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :starting_after
       sig {
-        params(created: T.any(::Stripe::CreditNote::ListParams::Created, Integer), customer: String, ending_before: String, expand: T::Array[String], invoice: String, limit: Integer, starting_after: String).void
+        params(created: T.nilable(T.any(::Stripe::CreditNote::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
        }
       def initialize(
         created: nil,
@@ -256,34 +257,36 @@ module Stripe
           def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
         end
         # The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :amount
         # The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :description
         # The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :invoice_line_item
         # The line item quantity to credit.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :quantity
         # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
-        sig { returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line::TaxAmount])) }
+        sig {
+          returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::CreateParams::Line::TaxAmount]))))
+         }
         attr_accessor :tax_amounts
         # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
-        sig { returns(T.nilable(T::Array[String])) }
+        sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
         attr_accessor :tax_rates
         # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
         sig { returns(String) }
         attr_accessor :type
         # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         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.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :unit_amount_decimal
         sig {
-          params(amount: Integer, description: String, invoice_line_item: String, quantity: Integer, tax_amounts: T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line::TaxAmount]), tax_rates: T.nilable(T::Array[String]), type: String, unit_amount: Integer, unit_amount_decimal: String).void
+          params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::CreateParams::Line::TaxAmount]))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
          }
         def initialize(
           amount: nil,
@@ -299,68 +302,65 @@ module Stripe
       end
       class Refund < Stripe::RequestParams
         # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :amount_refunded
         # ID of an existing refund to link this credit note to.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :refund
-        sig { params(amount_refunded: Integer, refund: String).void }
+        sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
         def initialize(amount_refunded: nil, refund: nil); end
       end
       class ShippingCost < Stripe::RequestParams
         # The ID of the shipping rate to use for this order.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :shipping_rate
-        sig { params(shipping_rate: String).void }
+        sig { params(shipping_rate: T.nilable(String)).void }
         def initialize(shipping_rate: nil); end
       end
       # The integer amount in cents (or local equivalent) representing the total amount of the credit note.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :amount
       # The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :credit_amount
       # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :effective_at
       # Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :email_type
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
       # ID of the invoice.
       sig { returns(String) }
       attr_accessor :invoice
       # Line items that make up the credit note.
-      sig { returns(T::Array[::Stripe::CreditNote::CreateParams::Line]) }
+      sig { returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line])) }
       attr_accessor :lines
       # The credit note's memo appears on the credit note PDF.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :memo
       # 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`.
-      sig { returns(T::Hash[String, String]) }
+      sig { returns(T.nilable(T::Hash[String, String])) }
       attr_accessor :metadata
       # The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :out_of_band_amount
       # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :reason
-      # ID of an existing refund to link this credit note to.
-      sig { returns(String) }
-      attr_accessor :refund
       # The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :refund_amount
       # Refunds to link to this credit note.
-      sig { returns(T::Array[::Stripe::CreditNote::CreateParams::Refund]) }
+      sig { returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Refund])) }
       attr_accessor :refunds
       # When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
-      sig { returns(::Stripe::CreditNote::CreateParams::ShippingCost) }
+      sig { returns(T.nilable(::Stripe::CreditNote::CreateParams::ShippingCost)) }
       attr_accessor :shipping_cost
       sig {
-        params(amount: Integer, credit_amount: Integer, effective_at: Integer, email_type: String, expand: T::Array[String], invoice: String, lines: T::Array[::Stripe::CreditNote::CreateParams::Line], memo: String, metadata: T::Hash[String, String], out_of_band_amount: Integer, reason: String, refund: String, refund_amount: Integer, refunds: T::Array[::Stripe::CreditNote::CreateParams::Refund], shipping_cost: ::Stripe::CreditNote::CreateParams::ShippingCost).void
+        params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, lines: T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNote::CreateParams::ShippingCost)).void
        }
       def initialize(
         amount: nil,
@@ -374,30 +374,24 @@ module Stripe
         metadata: nil,
         out_of_band_amount: nil,
         reason: nil,
-        refund: nil,
         refund_amount: nil,
         refunds: nil,
         shipping_cost: nil
       ); end
     end
-    class RetrieveParams < Stripe::RequestParams
-      # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
-      attr_accessor :expand
-      sig { params(expand: T::Array[String]).void }
-      def initialize(expand: nil); end
-    end
     class UpdateParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
       # Credit note memo.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :memo
       # 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`.
-      sig { returns(T::Hash[String, String]) }
+      sig { returns(T.nilable(T::Hash[String, String])) }
       attr_accessor :metadata
-      sig { params(expand: T::Array[String], memo: String, metadata: T::Hash[String, String]).void }
+      sig {
+        params(expand: T.nilable(T::Array[String]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String])).void
+       }
       def initialize(expand: nil, memo: nil, metadata: nil); end
     end
     class PreviewParams < Stripe::RequestParams
@@ -416,34 +410,36 @@ module Stripe
           def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
         end
         # The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :amount
         # The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :description
         # The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :invoice_line_item
         # The line item quantity to credit.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :quantity
         # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
-        sig { returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line::TaxAmount])) }
+        sig {
+          returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::PreviewParams::Line::TaxAmount]))))
+         }
         attr_accessor :tax_amounts
         # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
-        sig { returns(T.nilable(T::Array[String])) }
+        sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
         attr_accessor :tax_rates
         # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
         sig { returns(String) }
         attr_accessor :type
         # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         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.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :unit_amount_decimal
         sig {
-          params(amount: Integer, description: String, invoice_line_item: String, quantity: Integer, tax_amounts: T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line::TaxAmount]), tax_rates: T.nilable(T::Array[String]), type: String, unit_amount: Integer, unit_amount_decimal: String).void
+          params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::PreviewParams::Line::TaxAmount]))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
          }
         def initialize(
           amount: nil,
@@ -459,68 +455,65 @@ module Stripe
       end
       class Refund < Stripe::RequestParams
         # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :amount_refunded
         # ID of an existing refund to link this credit note to.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :refund
-        sig { params(amount_refunded: Integer, refund: String).void }
+        sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
         def initialize(amount_refunded: nil, refund: nil); end
       end
       class ShippingCost < Stripe::RequestParams
         # The ID of the shipping rate to use for this order.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :shipping_rate
-        sig { params(shipping_rate: String).void }
+        sig { params(shipping_rate: T.nilable(String)).void }
         def initialize(shipping_rate: nil); end
       end
       # The integer amount in cents (or local equivalent) representing the total amount of the credit note.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :amount
       # The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :credit_amount
       # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :effective_at
       # Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :email_type
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
       # ID of the invoice.
       sig { returns(String) }
       attr_accessor :invoice
       # Line items that make up the credit note.
-      sig { returns(T::Array[::Stripe::CreditNote::PreviewParams::Line]) }
+      sig { returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line])) }
       attr_accessor :lines
       # The credit note's memo appears on the credit note PDF.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :memo
       # 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`.
-      sig { returns(T::Hash[String, String]) }
+      sig { returns(T.nilable(T::Hash[String, String])) }
       attr_accessor :metadata
       # The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :out_of_band_amount
       # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :reason
-      # ID of an existing refund to link this credit note to.
-      sig { returns(String) }
-      attr_accessor :refund
       # The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :refund_amount
       # Refunds to link to this credit note.
-      sig { returns(T::Array[::Stripe::CreditNote::PreviewParams::Refund]) }
+      sig { returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Refund])) }
       attr_accessor :refunds
       # When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
-      sig { returns(::Stripe::CreditNote::PreviewParams::ShippingCost) }
+      sig { returns(T.nilable(::Stripe::CreditNote::PreviewParams::ShippingCost)) }
       attr_accessor :shipping_cost
       sig {
-        params(amount: Integer, credit_amount: Integer, effective_at: Integer, email_type: String, expand: T::Array[String], invoice: String, lines: T::Array[::Stripe::CreditNote::PreviewParams::Line], memo: String, metadata: T::Hash[String, String], out_of_band_amount: Integer, reason: String, refund: String, refund_amount: Integer, refunds: T::Array[::Stripe::CreditNote::PreviewParams::Refund], shipping_cost: ::Stripe::CreditNote::PreviewParams::ShippingCost).void
+        params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, lines: T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNote::PreviewParams::ShippingCost)).void
        }
       def initialize(
         amount: nil,
@@ -534,7 +527,6 @@ module Stripe
         metadata: nil,
         out_of_band_amount: nil,
         reason: nil,
-        refund: nil,
         refund_amount: nil,
         refunds: nil,
         shipping_cost: nil
@@ -556,36 +548,36 @@ module Stripe
           def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
         end
         # The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :amount
         # The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :description
         # The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :invoice_line_item
         # The line item quantity to credit.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :quantity
         # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
         sig {
-          returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line::TaxAmount]))
+          returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line::TaxAmount]))))
          }
         attr_accessor :tax_amounts
         # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
-        sig { returns(T.nilable(T::Array[String])) }
+        sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
         attr_accessor :tax_rates
         # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
         sig { returns(String) }
         attr_accessor :type
         # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         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.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :unit_amount_decimal
         sig {
-          params(amount: Integer, description: String, invoice_line_item: String, quantity: Integer, tax_amounts: T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line::TaxAmount]), tax_rates: T.nilable(T::Array[String]), type: String, unit_amount: Integer, unit_amount_decimal: String).void
+          params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line::TaxAmount]))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
          }
         def initialize(
           amount: nil,
@@ -601,77 +593,74 @@ module Stripe
       end
       class Refund < Stripe::RequestParams
         # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :amount_refunded
         # ID of an existing refund to link this credit note to.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :refund
-        sig { params(amount_refunded: Integer, refund: String).void }
+        sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
         def initialize(amount_refunded: nil, refund: nil); end
       end
       class ShippingCost < Stripe::RequestParams
         # The ID of the shipping rate to use for this order.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :shipping_rate
-        sig { params(shipping_rate: String).void }
+        sig { params(shipping_rate: T.nilable(String)).void }
         def initialize(shipping_rate: nil); end
       end
       # The integer amount in cents (or local equivalent) representing the total amount of the credit note.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :amount
       # The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :credit_amount
       # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :effective_at
       # Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :email_type
       # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :ending_before
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
       # ID of the invoice.
       sig { returns(String) }
       attr_accessor :invoice
       # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :limit
       # Line items that make up the credit note.
-      sig { returns(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line]) }
+      sig { returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line])) }
       attr_accessor :lines
       # The credit note's memo appears on the credit note PDF.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :memo
       # 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`.
-      sig { returns(T::Hash[String, String]) }
+      sig { returns(T.nilable(T::Hash[String, String])) }
       attr_accessor :metadata
       # The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :out_of_band_amount
       # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :reason
-      # ID of an existing refund to link this credit note to.
-      sig { returns(String) }
-      attr_accessor :refund
       # The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
-      sig { returns(Integer) }
+      sig { returns(T.nilable(Integer)) }
       attr_accessor :refund_amount
       # Refunds to link to this credit note.
-      sig { returns(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund]) }
+      sig { returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund])) }
       attr_accessor :refunds
       # When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
-      sig { returns(::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost) }
+      sig { returns(T.nilable(::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost)) }
       attr_accessor :shipping_cost
       # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :starting_after
       sig {
-        params(amount: Integer, credit_amount: Integer, effective_at: Integer, email_type: String, ending_before: String, expand: T::Array[String], invoice: String, limit: Integer, lines: T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line], memo: String, metadata: T::Hash[String, String], out_of_band_amount: Integer, reason: String, refund: String, refund_amount: Integer, refunds: T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund], shipping_cost: ::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost, starting_after: String).void
+        params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, limit: T.nilable(Integer), lines: T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost), starting_after: T.nilable(String)).void
        }
       def initialize(
         amount: nil,
@@ -687,7 +676,6 @@ module Stripe
         metadata: nil,
         out_of_band_amount: nil,
         reason: nil,
-        refund: nil,
         refund_amount: nil,
         refunds: nil,
         shipping_cost: nil,
@@ -696,9 +684,9 @@ module Stripe
     end
     class VoidCreditNoteParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :expand
-      sig { params(expand: T::Array[String]).void }
+      sig { params(expand: T.nilable(T::Array[String])).void }
       def initialize(expand: nil); end
     end
     # Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces