stripe 15.5.0.pre.beta.2 → 15.6.0.pre.alpha.1

data/lib/stripe/services/invoice_service.rb

@@ -2973,6 +2973,41 @@ module Stripe
               end
             end
 
+            class Period < Stripe::RequestParams
+              class End < Stripe::RequestParams
+                # A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
+                attr_accessor :timestamp
+                # Select how to calculate the end of the invoice item period.
+                attr_accessor :type
+
+                def initialize(timestamp: nil, type: nil)
+                  @timestamp = timestamp
+                  @type = type
+                end
+              end
+
+              class Start < Stripe::RequestParams
+                # A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
+                attr_accessor :timestamp
+                # Select how to calculate the start of the invoice item period.
+                attr_accessor :type
+
+                def initialize(timestamp: nil, type: nil)
+                  @timestamp = timestamp
+                  @type = type
+                end
+              end
+              # End of the invoice item period.
+              attr_accessor :end
+              # Start of the invoice item period.
+              attr_accessor :start
+
+              def initialize(end_: nil, start: nil)
+                @end = end_
+                @start = start
+              end
+            end
+
             class PriceData < 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
@@ -3001,6 +3036,10 @@ module Stripe
             end
             # The coupons to redeem into discounts for the item.
             attr_accessor :discounts
+            # 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 period associated with this invoice item. Defaults to the period of the underlying subscription that surrounds the start of the phase.
+            attr_accessor :period
             # The ID of the price object. One of `price` or `price_data` is required.
             attr_accessor :price
             # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
@@ -3012,12 +3051,16 @@ module Stripe
 
             def initialize(
               discounts: nil,
+              metadata: nil,
+              period: nil,
               price: nil,
               price_data: nil,
               quantity: nil,
               tax_rates: nil
             )
               @discounts = discounts
+              @metadata = metadata
+              @period = period
               @price = price
               @price_data = price_data
               @quantity = quantity
@@ -3739,6 +3782,8 @@ module Stripe
       end
       # Settings for automatic tax lookup for this invoice preview.
       attr_accessor :automatic_tax
+      # The identifier of the billing cadence for which you’d like to retrieve the upcoming invoice.Cannot be provided when `subscription`, `schedule`, `subscription_details` or `schedule_details` are provided.
+      attr_accessor :billing_cadence
       # The currency to preview this invoice in. Defaults to that of `customer` if not specified.
       attr_accessor :currency
       # The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
@@ -3770,6 +3815,7 @@ module Stripe
 
       def initialize(
         automatic_tax: nil,
+        billing_cadence: nil,
         currency: nil,
         customer: nil,
         customer_account: nil,
@@ -3786,6 +3832,7 @@ module Stripe
         subscription_details: nil
       )
         @automatic_tax = automatic_tax
+        @billing_cadence = billing_cadence
         @currency = currency
         @customer = customer
         @customer_account = customer_account

data/lib/stripe/services/mandate_service.rb

@@ -3,6 +3,41 @@
 
 module Stripe
   class MandateService < StripeService
+    class ListParams < Stripe::RequestParams
+      # 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.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # The Stripe account ID that the mandates are intended for. Learn more about the [use case for connected accounts payments](https://stripe.com/docs/payments/connected-accounts).
+      attr_accessor :on_behalf_of
+      # Attribute for param field payment_method
+      attr_accessor :payment_method
+      # 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.
+      attr_accessor :starting_after
+      # The status of the mandates to retrieve. Status indicates whether or not you can use it to initiate a payment, and can have a value of `active`, `pending`, or `inactive`.
+      attr_accessor :status
+
+      def initialize(
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        on_behalf_of: nil,
+        payment_method: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @on_behalf_of = on_behalf_of
+        @payment_method = payment_method
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
@@ -12,6 +47,11 @@ module Stripe
       end
     end
 
+    # Retrieves a list of Mandates for a given PaymentMethod.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/mandates", params: params, opts: opts, base_address: :api)
+    end
+
     # Retrieves a Mandate object.
     def retrieve(mandate, params = {}, opts = {})
       request(

data/lib/stripe/services/payment_attempt_record_service.rb

@@ -6,11 +6,14 @@ module Stripe
     class ListParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
       # The ID of the Payment Record.
       attr_accessor :payment_record
 
-      def initialize(expand: nil, payment_record: nil)
+      def initialize(expand: nil, limit: nil, payment_record: nil)
         @expand = expand
+        @limit = limit
         @payment_record = payment_record
       end
     end

data/lib/stripe/services/payment_intent_service.rb

@@ -2961,10 +2961,52 @@ module Stripe
         end
 
         class Pix < Stripe::RequestParams
+          class MandateOptions < Stripe::RequestParams
+            # Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
+            attr_accessor :amount
+            # Determines if the amount includes the IOF tax. Defaults to `never`.
+            attr_accessor :amount_includes_iof
+            # Type of amount. Defaults to `maximum`.
+            attr_accessor :amount_type
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
+            attr_accessor :currency
+            # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+            attr_accessor :end_date
+            # Schedule at which the future payments will be charged. Defaults to `weekly`.
+            attr_accessor :payment_schedule
+            # Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
+            attr_accessor :reference
+            # Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
+            attr_accessor :start_date
+
+            def initialize(
+              amount: nil,
+              amount_includes_iof: nil,
+              amount_type: nil,
+              currency: nil,
+              end_date: nil,
+              payment_schedule: nil,
+              reference: nil,
+              start_date: nil
+            )
+              @amount = amount
+              @amount_includes_iof = amount_includes_iof
+              @amount_type = amount_type
+              @currency = currency
+              @end_date = end_date
+              @payment_schedule = payment_schedule
+              @reference = reference
+              @start_date = start_date
+            end
+          end
+          # Determines if the amount includes the IOF tax. Defaults to `never`.
+          attr_accessor :amount_includes_iof
           # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
           attr_accessor :expires_after_seconds
           # The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
           attr_accessor :expires_at
+          # Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
+          attr_accessor :mandate_options
           # Indicates that you intend to make future payments with this PaymentIntent's payment method.
           #
           # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
@@ -2976,9 +3018,17 @@ module Stripe
           # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
           attr_accessor :setup_future_usage
 
-          def initialize(expires_after_seconds: nil, expires_at: nil, setup_future_usage: nil)
+          def initialize(
+            amount_includes_iof: nil,
+            expires_after_seconds: nil,
+            expires_at: nil,
+            mandate_options: nil,
+            setup_future_usage: nil
+          )
+            @amount_includes_iof = amount_includes_iof
             @expires_after_seconds = expires_after_seconds
             @expires_at = expires_at
+            @mandate_options = mandate_options
             @setup_future_usage = setup_future_usage
           end
         end
@@ -3689,6 +3739,8 @@ module Stripe
       attr_accessor :description
       # Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
       attr_accessor :error_on_requires_action
+      # The list of payment method types to exclude from use with this payment.
+      attr_accessor :excluded_payment_method_types
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
       # The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
@@ -3769,6 +3821,7 @@ module Stripe
         customer_account: nil,
         description: nil,
         error_on_requires_action: nil,
+        excluded_payment_method_types: nil,
         expand: nil,
         fx_quote: nil,
         hooks: nil,
@@ -3808,6 +3861,7 @@ module Stripe
         @customer_account = customer_account
         @description = description
         @error_on_requires_action = error_on_requires_action
+        @excluded_payment_method_types = excluded_payment_method_types
         @expand = expand
         @fx_quote = fx_quote
         @hooks = hooks
@@ -6725,10 +6779,52 @@ module Stripe
         end
 
         class Pix < Stripe::RequestParams
+          class MandateOptions < Stripe::RequestParams
+            # Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
+            attr_accessor :amount
+            # Determines if the amount includes the IOF tax. Defaults to `never`.
+            attr_accessor :amount_includes_iof
+            # Type of amount. Defaults to `maximum`.
+            attr_accessor :amount_type
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
+            attr_accessor :currency
+            # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+            attr_accessor :end_date
+            # Schedule at which the future payments will be charged. Defaults to `weekly`.
+            attr_accessor :payment_schedule
+            # Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
+            attr_accessor :reference
+            # Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
+            attr_accessor :start_date
+
+            def initialize(
+              amount: nil,
+              amount_includes_iof: nil,
+              amount_type: nil,
+              currency: nil,
+              end_date: nil,
+              payment_schedule: nil,
+              reference: nil,
+              start_date: nil
+            )
+              @amount = amount
+              @amount_includes_iof = amount_includes_iof
+              @amount_type = amount_type
+              @currency = currency
+              @end_date = end_date
+              @payment_schedule = payment_schedule
+              @reference = reference
+              @start_date = start_date
+            end
+          end
+          # Determines if the amount includes the IOF tax. Defaults to `never`.
+          attr_accessor :amount_includes_iof
           # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
           attr_accessor :expires_after_seconds
           # The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
           attr_accessor :expires_at
+          # Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
+          attr_accessor :mandate_options
           # Indicates that you intend to make future payments with this PaymentIntent's payment method.
           #
           # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
@@ -6740,9 +6836,17 @@ module Stripe
           # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
           attr_accessor :setup_future_usage
 
-          def initialize(expires_after_seconds: nil, expires_at: nil, setup_future_usage: nil)
+          def initialize(
+            amount_includes_iof: nil,
+            expires_after_seconds: nil,
+            expires_at: nil,
+            mandate_options: nil,
+            setup_future_usage: nil
+          )
+            @amount_includes_iof = amount_includes_iof
             @expires_after_seconds = expires_after_seconds
             @expires_at = expires_at
+            @mandate_options = mandate_options
             @setup_future_usage = setup_future_usage
           end
         end
@@ -11405,10 +11509,52 @@ module Stripe
         end
 
         class Pix < Stripe::RequestParams
+          class MandateOptions < Stripe::RequestParams
+            # Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
+            attr_accessor :amount
+            # Determines if the amount includes the IOF tax. Defaults to `never`.
+            attr_accessor :amount_includes_iof
+            # Type of amount. Defaults to `maximum`.
+            attr_accessor :amount_type
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
+            attr_accessor :currency
+            # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+            attr_accessor :end_date
+            # Schedule at which the future payments will be charged. Defaults to `weekly`.
+            attr_accessor :payment_schedule
+            # Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
+            attr_accessor :reference
+            # Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
+            attr_accessor :start_date
+
+            def initialize(
+              amount: nil,
+              amount_includes_iof: nil,
+              amount_type: nil,
+              currency: nil,
+              end_date: nil,
+              payment_schedule: nil,
+              reference: nil,
+              start_date: nil
+            )
+              @amount = amount
+              @amount_includes_iof = amount_includes_iof
+              @amount_type = amount_type
+              @currency = currency
+              @end_date = end_date
+              @payment_schedule = payment_schedule
+              @reference = reference
+              @start_date = start_date
+            end
+          end
+          # Determines if the amount includes the IOF tax. Defaults to `never`.
+          attr_accessor :amount_includes_iof
           # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
           attr_accessor :expires_after_seconds
           # The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
           attr_accessor :expires_at
+          # Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
+          attr_accessor :mandate_options
           # Indicates that you intend to make future payments with this PaymentIntent's payment method.
           #
           # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
@@ -11420,9 +11566,17 @@ module Stripe
           # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
           attr_accessor :setup_future_usage
 
-          def initialize(expires_after_seconds: nil, expires_at: nil, setup_future_usage: nil)
+          def initialize(
+            amount_includes_iof: nil,
+            expires_after_seconds: nil,
+            expires_at: nil,
+            mandate_options: nil,
+            setup_future_usage: nil
+          )
+            @amount_includes_iof = amount_includes_iof
             @expires_after_seconds = expires_after_seconds
             @expires_at = expires_at
+            @mandate_options = mandate_options
             @setup_future_usage = setup_future_usage
           end
         end

data/lib/stripe/services/payment_link_service.rb

@@ -438,7 +438,7 @@ module Stripe
         end
         # When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
         attr_accessor :adjustable_quantity
-        # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
+        # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
         attr_accessor :price
         # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
         attr_accessor :price_data

data/lib/stripe/services/payment_record_service.rb

@@ -243,7 +243,7 @@ module Stripe
       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 [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal 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)
@@ -365,6 +365,26 @@ module Stripe
         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.
@@ -431,8 +451,8 @@ module Stripe
       attr_accessor :outcome
       # Information about the Payment Method debited for this payment.
       attr_accessor :payment_method_details
-      # An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
-      attr_accessor :payment_reference
+      # Processor information for this payment.
+      attr_accessor :processor_details
       # Shipping information for this payment.
       attr_accessor :shipping_details
 
@@ -448,7 +468,7 @@ module Stripe
         metadata: nil,
         outcome: nil,
         payment_method_details: nil,
-        payment_reference: nil,
+        processor_details: nil,
         shipping_details: nil
       )
         @amount_requested = amount_requested
@@ -462,7 +482,7 @@ module Stripe
         @metadata = metadata
         @outcome = outcome
         @payment_method_details = payment_method_details
-        @payment_reference = payment_reference
+        @processor_details = processor_details
         @shipping_details = shipping_details
       end
     end

data/lib/stripe/services/quote_service.rb

@@ -3,16 +3,16 @@
 
 module Stripe
   class QuoteService < StripeService
-    attr_reader :preview_invoices, :preview_subscription_schedules, :lines, :line_items, :computed_upfront_line_items
+    attr_reader :computed_upfront_line_items, :lines, :line_items, :preview_invoices, :preview_subscription_schedules
 
     def initialize(requestor)
       super
+      @computed_upfront_line_items = Stripe::QuoteComputedUpfrontLineItemsService.new(@requestor)
+      @lines = Stripe::QuoteLineService.new(@requestor)
+      @line_items = Stripe::QuoteLineItemService.new(@requestor)
       @preview_invoices = Stripe::QuotePreviewInvoiceService.new(@requestor)
       @preview_subscription_schedules = Stripe::QuotePreviewSubscriptionScheduleService
                                         .new(@requestor)
-      @lines = Stripe::QuoteLineService.new(@requestor)
-      @line_items = Stripe::QuoteLineItemService.new(@requestor)
-      @computed_upfront_line_items = Stripe::QuoteComputedUpfrontLineItemsService.new(@requestor)
     end
 
     class ListParams < Stripe::RequestParams