stripe 17.0.1 → 19.0.0

data/lib/stripe/params/invoice_create_params.rb

@@ -2,9 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
-  class InvoiceCreateParams < Stripe::RequestParams
-    class AutomaticTax < Stripe::RequestParams
-      class Liability < Stripe::RequestParams
+  class InvoiceCreateParams < ::Stripe::RequestParams
+    class AutomaticTax < ::Stripe::RequestParams
+      class Liability < ::Stripe::RequestParams
         # The connected account being referenced when `type` is `account`.
         attr_accessor :account
         # Type of the account referenced in the request.
@@ -15,7 +15,7 @@ module Stripe
           @type = type
         end
       end
-      # Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
+      # Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
       attr_accessor :enabled
       # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
       attr_accessor :liability
@@ -26,7 +26,7 @@ module Stripe
       end
     end
 
-    class CustomField < Stripe::RequestParams
+    class CustomField < ::Stripe::RequestParams
       # The name of the custom field. This may be up to 40 characters.
       attr_accessor :name
       # The value of the custom field. This may be up to 140 characters.
@@ -38,7 +38,7 @@ module Stripe
       end
     end
 
-    class Discount < Stripe::RequestParams
+    class Discount < ::Stripe::RequestParams
       # ID of the coupon to create a new discount for.
       attr_accessor :coupon
       # ID of an existing discount on the object (or one of its ancestors) to reuse.
@@ -53,7 +53,7 @@ module Stripe
       end
     end
 
-    class FromInvoice < Stripe::RequestParams
+    class FromInvoice < ::Stripe::RequestParams
       # The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted
       attr_accessor :action
       # The `id` of the invoice that will be cloned.
@@ -65,7 +65,7 @@ module Stripe
       end
     end
 
-    class Issuer < Stripe::RequestParams
+    class Issuer < ::Stripe::RequestParams
       # The connected account being referenced when `type` is `account`.
       attr_accessor :account
       # Type of the account referenced in the request.
@@ -77,10 +77,10 @@ module Stripe
       end
     end
 
-    class PaymentSettings < Stripe::RequestParams
-      class PaymentMethodOptions < Stripe::RequestParams
-        class AcssDebit < Stripe::RequestParams
-          class MandateOptions < Stripe::RequestParams
+    class PaymentSettings < ::Stripe::RequestParams
+      class PaymentMethodOptions < ::Stripe::RequestParams
+        class AcssDebit < ::Stripe::RequestParams
+          class MandateOptions < ::Stripe::RequestParams
             # Transaction type of the mandate.
             attr_accessor :transaction_type
 
@@ -99,7 +99,7 @@ module Stripe
           end
         end
 
-        class Bancontact < Stripe::RequestParams
+        class Bancontact < ::Stripe::RequestParams
           # Preferred language of the Bancontact authorization page that the customer is redirected to.
           attr_accessor :preferred_language
 
@@ -108,9 +108,9 @@ module Stripe
           end
         end
 
-        class Card < Stripe::RequestParams
-          class Installments < Stripe::RequestParams
-            class Plan < Stripe::RequestParams
+        class Card < ::Stripe::RequestParams
+          class Installments < ::Stripe::RequestParams
+            class Plan < ::Stripe::RequestParams
               # For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
               attr_accessor :count
               # For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
@@ -138,9 +138,9 @@ module Stripe
           end
           # Installment configuration for payments attempted on this invoice.
           #
-          # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
+          # For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments).
           attr_accessor :installments
-          # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
+          # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
           attr_accessor :request_three_d_secure
 
           def initialize(installments: nil, request_three_d_secure: nil)
@@ -149,10 +149,10 @@ module Stripe
           end
         end
 
-        class CustomerBalance < Stripe::RequestParams
-          class BankTransfer < Stripe::RequestParams
-            class EuBankTransfer < Stripe::RequestParams
-              # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
+        class CustomerBalance < ::Stripe::RequestParams
+          class BankTransfer < ::Stripe::RequestParams
+            class EuBankTransfer < ::Stripe::RequestParams
+              # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`.
               attr_accessor :country
 
               def initialize(country: nil)
@@ -180,12 +180,33 @@ module Stripe
           end
         end
 
-        class Konbini < Stripe::RequestParams; end
-        class SepaDebit < Stripe::RequestParams; end
+        class Konbini < ::Stripe::RequestParams; end
 
-        class UsBankAccount < Stripe::RequestParams
-          class FinancialConnections < Stripe::RequestParams
-            class Filters < Stripe::RequestParams
+        class Payto < ::Stripe::RequestParams
+          class MandateOptions < ::Stripe::RequestParams
+            # The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
+            attr_accessor :amount
+            # The purpose for which payments are made. Has a default value based on your merchant category code.
+            attr_accessor :purpose
+
+            def initialize(amount: nil, purpose: nil)
+              @amount = amount
+              @purpose = purpose
+            end
+          end
+          # Additional fields for Mandate creation.
+          attr_accessor :mandate_options
+
+          def initialize(mandate_options: nil)
+            @mandate_options = mandate_options
+          end
+        end
+
+        class SepaDebit < ::Stripe::RequestParams; end
+
+        class UsBankAccount < ::Stripe::RequestParams
+          class FinancialConnections < ::Stripe::RequestParams
+            class Filters < ::Stripe::RequestParams
               # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
               attr_accessor :account_subcategories
 
@@ -226,6 +247,8 @@ module Stripe
         attr_accessor :customer_balance
         # If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
         attr_accessor :konbini
+        # If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
+        attr_accessor :payto
         # If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
         attr_accessor :sepa_debit
         # If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
@@ -237,6 +260,7 @@ module Stripe
           card: nil,
           customer_balance: nil,
           konbini: nil,
+          payto: nil,
           sepa_debit: nil,
           us_bank_account: nil
         )
@@ -245,6 +269,7 @@ module Stripe
           @card = card
           @customer_balance = customer_balance
           @konbini = konbini
+          @payto = payto
           @sepa_debit = sepa_debit
           @us_bank_account = us_bank_account
         end
@@ -263,8 +288,8 @@ module Stripe
       end
     end
 
-    class Rendering < Stripe::RequestParams
-      class Pdf < Stripe::RequestParams
+    class Rendering < ::Stripe::RequestParams
+      class Pdf < ::Stripe::RequestParams
         # Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.
         #  If set to `auto`, invoice PDF page size defaults to `a4` for customers with
         #  Japanese locale and `letter` for customers with other locales.
@@ -291,10 +316,10 @@ module Stripe
       end
     end
 
-    class ShippingCost < Stripe::RequestParams
-      class ShippingRateData < Stripe::RequestParams
-        class DeliveryEstimate < Stripe::RequestParams
-          class Maximum < Stripe::RequestParams
+    class ShippingCost < ::Stripe::RequestParams
+      class ShippingRateData < ::Stripe::RequestParams
+        class DeliveryEstimate < ::Stripe::RequestParams
+          class Maximum < ::Stripe::RequestParams
             # A unit of time.
             attr_accessor :unit
             # Must be greater than 0.
@@ -306,7 +331,7 @@ module Stripe
             end
           end
 
-          class Minimum < Stripe::RequestParams
+          class Minimum < ::Stripe::RequestParams
             # A unit of time.
             attr_accessor :unit
             # Must be greater than 0.
@@ -328,8 +353,8 @@ module Stripe
           end
         end
 
-        class FixedAmount < Stripe::RequestParams
-          class CurrencyOptions < Stripe::RequestParams
+        class FixedAmount < ::Stripe::RequestParams
+          class CurrencyOptions < ::Stripe::RequestParams
             # A non-negative integer in cents representing how much to charge.
             attr_accessor :amount
             # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
@@ -359,11 +384,11 @@ module Stripe
         attr_accessor :display_name
         # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
         attr_accessor :fixed_amount
-        # 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`.
+        # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
         attr_accessor :metadata
         # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
         attr_accessor :tax_behavior
-        # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
+        # A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
         attr_accessor :tax_code
         # The type of calculation to use on the shipping rate.
         attr_accessor :type
@@ -397,8 +422,8 @@ module Stripe
       end
     end
 
-    class ShippingDetails < Stripe::RequestParams
-      class Address < Stripe::RequestParams
+    class ShippingDetails < ::Stripe::RequestParams
+      class Address < ::Stripe::RequestParams
         # City, district, suburb, town, or village.
         attr_accessor :city
         # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -409,7 +434,7 @@ module Stripe
         attr_accessor :line2
         # ZIP or postal code.
         attr_accessor :postal_code
-        # State, county, province, or region.
+        # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
         attr_accessor :state
 
         def initialize(
@@ -442,7 +467,7 @@ module Stripe
       end
     end
 
-    class TransferData < Stripe::RequestParams
+    class TransferData < ::Stripe::RequestParams
       # The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
       attr_accessor :amount
       # ID of an existing, connected Stripe account.
@@ -455,9 +480,9 @@ module Stripe
     end
     # The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
     attr_accessor :account_tax_ids
-    # A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
+    # A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees).
     attr_accessor :application_fee_amount
-    # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false.
+    # Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false.
     attr_accessor :auto_advance
     # Settings for automatic tax lookup for this invoice.
     attr_accessor :automatic_tax
@@ -469,8 +494,10 @@ module Stripe
     attr_accessor :currency
     # A list of up to 4 custom fields to be displayed on the invoice.
     attr_accessor :custom_fields
-    # The ID of the customer who will be billed.
+    # The ID of the customer to bill.
     attr_accessor :customer
+    # The ID of the account to bill.
+    attr_accessor :customer_account
     # The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
     attr_accessor :days_until_due
     # ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
@@ -491,15 +518,15 @@ module Stripe
     attr_accessor :expand
     # Footer to be displayed on the invoice.
     attr_accessor :footer
-    # Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
+    # Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details.
     attr_accessor :from_invoice
     # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
     attr_accessor :issuer
-    # 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`.
+    # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
     attr_accessor :metadata
     # Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
     attr_accessor :number
-    # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
+    # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.
     attr_accessor :on_behalf_of
     # Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
     attr_accessor :payment_settings
@@ -528,6 +555,7 @@ module Stripe
       currency: nil,
       custom_fields: nil,
       customer: nil,
+      customer_account: nil,
       days_until_due: nil,
       default_payment_method: nil,
       default_source: nil,
@@ -561,6 +589,7 @@ module Stripe
       @currency = currency
       @custom_fields = custom_fields
       @customer = customer
+      @customer_account = customer_account
       @days_until_due = days_until_due
       @default_payment_method = default_payment_method
       @default_source = default_source