stripe 17.0.0 → 17.1.0.pre.beta.1

data/lib/stripe/params/payment_method_update_params.rb

@@ -77,6 +77,21 @@ module Stripe
       end
     end
 
+    class Payto < Stripe::RequestParams
+      # The account number for the bank account.
+      attr_accessor :account_number
+      # Bank-State-Branch number of the bank account.
+      attr_accessor :bsb_number
+      # The PayID alias for the bank account.
+      attr_accessor :pay_id
+
+      def initialize(account_number: nil, bsb_number: nil, pay_id: nil)
+        @account_number = account_number
+        @bsb_number = bsb_number
+        @pay_id = pay_id
+      end
+    end
+
     class UsBankAccount < Stripe::RequestParams
       # Bank account holder type.
       attr_accessor :account_holder_type
@@ -98,6 +113,8 @@ module Stripe
     attr_accessor :expand
     # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
     attr_accessor :metadata
+    # If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+    attr_accessor :payto
     # If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
     attr_accessor :us_bank_account
 
@@ -107,6 +124,7 @@ module Stripe
       card: nil,
       expand: nil,
       metadata: nil,
+      payto: nil,
       us_bank_account: nil
     )
       @allow_redisplay = allow_redisplay
@@ -114,6 +132,7 @@ module Stripe
       @card = card
       @expand = expand
       @metadata = metadata
+      @payto = payto
       @us_bank_account = us_bank_account
     end
   end

data/lib/stripe/params/payment_record_report_payment_attempt_canceled_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordReportPaymentAttemptCanceledParams < Stripe::RequestParams
+    # When the reported payment was canceled. Measured in seconds since the Unix epoch.
+    attr_accessor :canceled_at
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # Attribute for param field metadata
+    attr_accessor :metadata
+
+    def initialize(canceled_at: nil, expand: nil, metadata: nil)
+      @canceled_at = canceled_at
+      @expand = expand
+      @metadata = metadata
+    end
+  end
+end

data/lib/stripe/params/payment_record_report_payment_attempt_failed_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordReportPaymentAttemptFailedParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # When the reported payment failed. Measured in seconds since the Unix epoch.
+    attr_accessor :failed_at
+    # Attribute for param field metadata
+    attr_accessor :metadata
+
+    def initialize(expand: nil, failed_at: nil, metadata: nil)
+      @expand = expand
+      @failed_at = failed_at
+      @metadata = metadata
+    end
+  end
+end

data/lib/stripe/params/payment_record_report_payment_attempt_guaranteed_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordReportPaymentAttemptGuaranteedParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+    attr_accessor :guaranteed_at
+    # Attribute for param field metadata
+    attr_accessor :metadata
+
+    def initialize(expand: nil, guaranteed_at: nil, metadata: nil)
+      @expand = expand
+      @guaranteed_at = guaranteed_at
+      @metadata = metadata
+    end
+  end
+end

data/lib/stripe/params/payment_record_report_payment_attempt_informational_params.rb

@@ -0,0 +1,93 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordReportPaymentAttemptInformationalParams < Stripe::RequestParams
+    class CustomerDetails < Stripe::RequestParams
+      # The customer who made the payment.
+      attr_accessor :customer
+      # The customer's phone number.
+      attr_accessor :email
+      # The customer's name.
+      attr_accessor :name
+      # The customer's phone number.
+      attr_accessor :phone
+
+      def initialize(customer: nil, email: nil, name: nil, phone: nil)
+        @customer = customer
+        @email = email
+        @name = name
+        @phone = phone
+      end
+    end
+
+    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)).
+        attr_accessor :country
+        # Address line 1, such as the street, PO Box, or company name.
+        attr_accessor :line1
+        # Address line 2, such as the apartment, suite, unit, or building.
+        attr_accessor :line2
+        # ZIP or postal code.
+        attr_accessor :postal_code
+        # State, county, province, or region.
+        attr_accessor :state
+
+        def initialize(
+          city: nil,
+          country: nil,
+          line1: nil,
+          line2: nil,
+          postal_code: nil,
+          state: nil
+        )
+          @city = city
+          @country = country
+          @line1 = line1
+          @line2 = line2
+          @postal_code = postal_code
+          @state = state
+        end
+      end
+      # The physical shipping address.
+      attr_accessor :address
+      # The shipping recipient's name.
+      attr_accessor :name
+      # The shipping recipient's phone number.
+      attr_accessor :phone
+
+      def initialize(address: nil, name: nil, phone: nil)
+        @address = address
+        @name = name
+        @phone = phone
+      end
+    end
+    # Customer information for this payment.
+    attr_accessor :customer_details
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+    # Shipping information for this payment.
+    attr_accessor :shipping_details
+
+    def initialize(
+      customer_details: nil,
+      description: nil,
+      expand: nil,
+      metadata: nil,
+      shipping_details: nil
+    )
+      @customer_details = customer_details
+      @description = description
+      @expand = expand
+      @metadata = metadata
+      @shipping_details = shipping_details
+    end
+  end
+end

data/lib/stripe/params/payment_record_report_payment_attempt_params.rb

@@ -0,0 +1,186 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordReportPaymentAttemptParams < Stripe::RequestParams
+    class Failed < Stripe::RequestParams
+      # When the reported payment failed. Measured in seconds since the Unix epoch.
+      attr_accessor :failed_at
+
+      def initialize(failed_at: nil)
+        @failed_at = failed_at
+      end
+    end
+
+    class Guaranteed < Stripe::RequestParams
+      # When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+      attr_accessor :guaranteed_at
+
+      def initialize(guaranteed_at: nil)
+        @guaranteed_at = guaranteed_at
+      end
+    end
+
+    class PaymentMethodDetails < Stripe::RequestParams
+      class BillingDetails < 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)).
+          attr_accessor :country
+          # Address line 1, such as the street, PO Box, or company name.
+          attr_accessor :line1
+          # Address line 2, such as the apartment, suite, unit, or building.
+          attr_accessor :line2
+          # ZIP or postal code.
+          attr_accessor :postal_code
+          # State, county, province, or region.
+          attr_accessor :state
+
+          def initialize(
+            city: nil,
+            country: nil,
+            line1: nil,
+            line2: nil,
+            postal_code: nil,
+            state: nil
+          )
+            @city = city
+            @country = country
+            @line1 = line1
+            @line2 = line2
+            @postal_code = postal_code
+            @state = state
+          end
+        end
+        # The billing address associated with the method of payment.
+        attr_accessor :address
+        # The billing email associated with the method of payment.
+        attr_accessor :email
+        # The billing name associated with the method of payment.
+        attr_accessor :name
+        # The billing phone number associated with the method of payment.
+        attr_accessor :phone
+
+        def initialize(address: nil, email: nil, name: nil, phone: nil)
+          @address = address
+          @email = email
+          @name = name
+          @phone = phone
+        end
+      end
+
+      class Custom < Stripe::RequestParams
+        # Display name for the custom (user-defined) payment method type used to make this payment.
+        attr_accessor :display_name
+        # The custom payment method type associated with this payment.
+        attr_accessor :type
+
+        def initialize(display_name: nil, type: nil)
+          @display_name = display_name
+          @type = type
+        end
+      end
+      # The billing details associated with the method of payment.
+      attr_accessor :billing_details
+      # Information about the custom (user-defined) payment method used to make this payment.
+      attr_accessor :custom
+      # ID of the Stripe Payment Method used to make this payment.
+      attr_accessor :payment_method
+      # The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
+      attr_accessor :type
+
+      def initialize(billing_details: nil, custom: nil, payment_method: nil, type: nil)
+        @billing_details = billing_details
+        @custom = custom
+        @payment_method = payment_method
+        @type = type
+      end
+    end
+
+    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)).
+        attr_accessor :country
+        # Address line 1, such as the street, PO Box, or company name.
+        attr_accessor :line1
+        # Address line 2, such as the apartment, suite, unit, or building.
+        attr_accessor :line2
+        # ZIP or postal code.
+        attr_accessor :postal_code
+        # State, county, province, or region.
+        attr_accessor :state
+
+        def initialize(
+          city: nil,
+          country: nil,
+          line1: nil,
+          line2: nil,
+          postal_code: nil,
+          state: nil
+        )
+          @city = city
+          @country = country
+          @line1 = line1
+          @line2 = line2
+          @postal_code = postal_code
+          @state = state
+        end
+      end
+      # The physical shipping address.
+      attr_accessor :address
+      # The shipping recipient's name.
+      attr_accessor :name
+      # The shipping recipient's phone number.
+      attr_accessor :phone
+
+      def initialize(address: nil, name: nil, phone: nil)
+        @address = address
+        @name = name
+        @phone = phone
+      end
+    end
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # Information about the payment attempt failure.
+    attr_accessor :failed
+    # Information about the payment attempt guarantee.
+    attr_accessor :guaranteed
+    # When the reported payment was initiated. Measured in seconds since the Unix epoch.
+    attr_accessor :initiated_at
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+    # The outcome of the reported payment.
+    attr_accessor :outcome
+    # Information about the Payment Method debited for this payment.
+    attr_accessor :payment_method_details
+    # Shipping information for this payment.
+    attr_accessor :shipping_details
+
+    def initialize(
+      description: nil,
+      expand: nil,
+      failed: nil,
+      guaranteed: nil,
+      initiated_at: nil,
+      metadata: nil,
+      outcome: nil,
+      payment_method_details: nil,
+      shipping_details: nil
+    )
+      @description = description
+      @expand = expand
+      @failed = failed
+      @guaranteed = guaranteed
+      @initiated_at = initiated_at
+      @metadata = metadata
+      @outcome = outcome
+      @payment_method_details = payment_method_details
+      @shipping_details = shipping_details
+    end
+  end
+end

data/lib/stripe/params/payment_record_report_payment_params.rb

@@ -0,0 +1,252 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordReportPaymentParams < Stripe::RequestParams
+    class AmountRequested < Stripe::RequestParams
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_accessor :currency
+      # A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
+      attr_accessor :value
+
+      def initialize(currency: nil, value: nil)
+        @currency = currency
+        @value = value
+      end
+    end
+
+    class CustomerDetails < Stripe::RequestParams
+      # The customer who made the payment.
+      attr_accessor :customer
+      # The customer's phone number.
+      attr_accessor :email
+      # The customer's name.
+      attr_accessor :name
+      # The customer's phone number.
+      attr_accessor :phone
+
+      def initialize(customer: nil, email: nil, name: nil, phone: nil)
+        @customer = customer
+        @email = email
+        @name = name
+        @phone = phone
+      end
+    end
+
+    class Failed < Stripe::RequestParams
+      # When the reported payment failed. Measured in seconds since the Unix epoch.
+      attr_accessor :failed_at
+
+      def initialize(failed_at: nil)
+        @failed_at = failed_at
+      end
+    end
+
+    class Guaranteed < Stripe::RequestParams
+      # When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+      attr_accessor :guaranteed_at
+
+      def initialize(guaranteed_at: nil)
+        @guaranteed_at = guaranteed_at
+      end
+    end
+
+    class PaymentMethodDetails < Stripe::RequestParams
+      class BillingDetails < 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)).
+          attr_accessor :country
+          # Address line 1, such as the street, PO Box, or company name.
+          attr_accessor :line1
+          # Address line 2, such as the apartment, suite, unit, or building.
+          attr_accessor :line2
+          # ZIP or postal code.
+          attr_accessor :postal_code
+          # State, county, province, or region.
+          attr_accessor :state
+
+          def initialize(
+            city: nil,
+            country: nil,
+            line1: nil,
+            line2: nil,
+            postal_code: nil,
+            state: nil
+          )
+            @city = city
+            @country = country
+            @line1 = line1
+            @line2 = line2
+            @postal_code = postal_code
+            @state = state
+          end
+        end
+        # The billing address associated with the method of payment.
+        attr_accessor :address
+        # The billing email associated with the method of payment.
+        attr_accessor :email
+        # The billing name associated with the method of payment.
+        attr_accessor :name
+        # The billing phone number associated with the method of payment.
+        attr_accessor :phone
+
+        def initialize(address: nil, email: nil, name: nil, phone: nil)
+          @address = address
+          @email = email
+          @name = name
+          @phone = phone
+        end
+      end
+
+      class Custom < Stripe::RequestParams
+        # Display name for the custom (user-defined) payment method type used to make this payment.
+        attr_accessor :display_name
+        # The custom payment method type associated with this payment.
+        attr_accessor :type
+
+        def initialize(display_name: nil, type: nil)
+          @display_name = display_name
+          @type = type
+        end
+      end
+      # The billing details associated with the method of payment.
+      attr_accessor :billing_details
+      # Information about the custom (user-defined) payment method used to make this payment.
+      attr_accessor :custom
+      # ID of the Stripe Payment Method used to make this payment.
+      attr_accessor :payment_method
+      # The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
+      attr_accessor :type
+
+      def initialize(billing_details: nil, custom: nil, payment_method: nil, type: nil)
+        @billing_details = billing_details
+        @custom = custom
+        @payment_method = payment_method
+        @type = type
+      end
+    end
+
+    class ProcessorDetails < Stripe::RequestParams
+      class Custom < Stripe::RequestParams
+        # An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+        attr_accessor :payment_reference
+
+        def initialize(payment_reference: nil)
+          @payment_reference = payment_reference
+        end
+      end
+      # Information about the custom processor used to make this payment.
+      attr_accessor :custom
+      # The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+      attr_accessor :type
+
+      def initialize(custom: nil, type: nil)
+        @custom = custom
+        @type = type
+      end
+    end
+
+    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)).
+        attr_accessor :country
+        # Address line 1, such as the street, PO Box, or company name.
+        attr_accessor :line1
+        # Address line 2, such as the apartment, suite, unit, or building.
+        attr_accessor :line2
+        # ZIP or postal code.
+        attr_accessor :postal_code
+        # State, county, province, or region.
+        attr_accessor :state
+
+        def initialize(
+          city: nil,
+          country: nil,
+          line1: nil,
+          line2: nil,
+          postal_code: nil,
+          state: nil
+        )
+          @city = city
+          @country = country
+          @line1 = line1
+          @line2 = line2
+          @postal_code = postal_code
+          @state = state
+        end
+      end
+      # The physical shipping address.
+      attr_accessor :address
+      # The shipping recipient's name.
+      attr_accessor :name
+      # The shipping recipient's phone number.
+      attr_accessor :phone
+
+      def initialize(address: nil, name: nil, phone: nil)
+        @address = address
+        @name = name
+        @phone = phone
+      end
+    end
+    # The amount you initially requested for this payment.
+    attr_accessor :amount_requested
+    # Customer information for this payment.
+    attr_accessor :customer_details
+    # Indicates whether the customer was present in your checkout flow during this payment.
+    attr_accessor :customer_presence
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # Information about the payment attempt failure.
+    attr_accessor :failed
+    # Information about the payment attempt guarantee.
+    attr_accessor :guaranteed
+    # When the reported payment was initiated. Measured in seconds since the Unix epoch.
+    attr_accessor :initiated_at
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+    # The outcome of the reported payment.
+    attr_accessor :outcome
+    # Information about the Payment Method debited for this payment.
+    attr_accessor :payment_method_details
+    # Processor information for this payment.
+    attr_accessor :processor_details
+    # Shipping information for this payment.
+    attr_accessor :shipping_details
+
+    def initialize(
+      amount_requested: nil,
+      customer_details: nil,
+      customer_presence: nil,
+      description: nil,
+      expand: nil,
+      failed: nil,
+      guaranteed: nil,
+      initiated_at: nil,
+      metadata: nil,
+      outcome: nil,
+      payment_method_details: nil,
+      processor_details: nil,
+      shipping_details: nil
+    )
+      @amount_requested = amount_requested
+      @customer_details = customer_details
+      @customer_presence = customer_presence
+      @description = description
+      @expand = expand
+      @failed = failed
+      @guaranteed = guaranteed
+      @initiated_at = initiated_at
+      @metadata = metadata
+      @outcome = outcome
+      @payment_method_details = payment_method_details
+      @processor_details = processor_details
+      @shipping_details = shipping_details
+    end
+  end
+end

data/lib/stripe/params/payment_record_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordRetrieveParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/price_update_params.rb

@@ -73,6 +73,21 @@ module Stripe
         @unit_amount_decimal = unit_amount_decimal
       end
     end
+
+    class MigrateTo < Stripe::RequestParams
+      # The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
+      attr_accessor :behavior
+      # The time after which subscriptions should start using the new price.
+      attr_accessor :effective_after
+      # The ID of the price object.
+      attr_accessor :price
+
+      def initialize(behavior: nil, effective_after: nil, price: nil)
+        @behavior = behavior
+        @effective_after = effective_after
+        @price = price
+      end
+    end
     # Whether the price can be used for new purchases. Defaults to `true`.
     attr_accessor :active
     # Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
@@ -83,6 +98,8 @@ module Stripe
     attr_accessor :lookup_key
     # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
     attr_accessor :metadata
+    # If specified, subscriptions using this price will be updated to use the new referenced price.
+    attr_accessor :migrate_to
     # A brief description of the price, hidden from customers.
     attr_accessor :nickname
     # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
@@ -96,6 +113,7 @@ module Stripe
       expand: nil,
       lookup_key: nil,
       metadata: nil,
+      migrate_to: nil,
       nickname: nil,
       tax_behavior: nil,
       transfer_lookup_key: nil
@@ -105,6 +123,7 @@ module Stripe
       @expand = expand
       @lookup_key = lookup_key
       @metadata = metadata
+      @migrate_to = migrate_to
       @nickname = nickname
       @tax_behavior = tax_behavior
       @transfer_lookup_key = transfer_lookup_key