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

data/lib/stripe/resources/setup_attempt.rb

@@ -169,6 +169,7 @@ module Stripe
       class NzBankAccount < Stripe::StripeObject; end
       class Paypal < Stripe::StripeObject; end
       class Payto < Stripe::StripeObject; end
+      class Pix < Stripe::StripeObject; end
       class RevolutPay < Stripe::StripeObject; end
       class SepaDebit < Stripe::StripeObject; end
 
@@ -233,6 +234,8 @@ module Stripe
       attr_reader :paypal
       # Attribute for field payto
       attr_reader :payto
+      # Attribute for field pix
+      attr_reader :pix
       # Attribute for field revolut_pay
       attr_reader :revolut_pay
       # Attribute for field sepa_debit
@@ -262,7 +265,7 @@ module Stripe
       attr_reader :message
       # For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
       attr_reader :network_advice_code
-      # For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
+      # For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
       attr_reader :network_decline_code
       # If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
       attr_reader :param

data/lib/stripe/resources/setup_intent.rb

@@ -57,7 +57,7 @@ module Stripe
       attr_reader :message
       # For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
       attr_reader :network_advice_code
-      # For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
+      # For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
       attr_reader :network_decline_code
       # If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
       attr_reader :param
@@ -129,6 +129,19 @@ module Stripe
         attr_reader :qr_code
       end
 
+      class PixDisplayQrCode < Stripe::StripeObject
+        # The raw data string used to generate QR code, it should be used together with QR code library.
+        attr_reader :data
+        # The date (unix timestamp) when the PIX expires.
+        attr_reader :expires_at
+        # The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
+        attr_reader :hosted_instructions_url
+        # The image_url_png string used to render png QR code
+        attr_reader :image_url_png
+        # The image_url_svg string used to render svg QR code
+        attr_reader :image_url_svg
+      end
+
       class RedirectToUrl < Stripe::StripeObject
         # If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
         attr_reader :return_url
@@ -146,6 +159,8 @@ module Stripe
       end
       # Attribute for field cashapp_handle_redirect_or_display_qr_code
       attr_reader :cashapp_handle_redirect_or_display_qr_code
+      # Attribute for field pix_display_qr_code
+      attr_reader :pix_display_qr_code
       # Attribute for field redirect_to_url
       attr_reader :redirect_to_url
       # Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.
@@ -271,6 +286,29 @@ module Stripe
         attr_reader :mandate_options
       end
 
+      class Pix < Stripe::StripeObject
+        class MandateOptions < Stripe::StripeObject
+          # Amount to be charged for future payments.
+          attr_reader :amount
+          # Determines if the amount includes the IOF tax.
+          attr_reader :amount_includes_iof
+          # Type of amount.
+          attr_reader :amount_type
+          # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+          attr_reader :currency
+          # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
+          attr_reader :end_date
+          # Schedule at which the future payments will be charged.
+          attr_reader :payment_schedule
+          # Subscription name displayed to buyers in their bank app.
+          attr_reader :reference
+          # Start date of the mandate, in `YYYY-MM-DD`.
+          attr_reader :start_date
+        end
+        # Attribute for field mandate_options
+        attr_reader :mandate_options
+      end
+
       class SepaDebit < Stripe::StripeObject
         class MandateOptions < Stripe::StripeObject
           # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
@@ -334,6 +372,8 @@ module Stripe
       attr_reader :paypal
       # Attribute for field payto
       attr_reader :payto
+      # Attribute for field pix
+      attr_reader :pix
       # Attribute for field sepa_debit
       attr_reader :sepa_debit
       # Attribute for field us_bank_account
@@ -1433,6 +1473,53 @@ module Stripe
           end
         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
+          # Additional fields for mandate creation.
+          attr_accessor :mandate_options
+
+          def initialize(mandate_options: nil)
+            @mandate_options = mandate_options
+          end
+        end
+
         class SepaDebit < Stripe::RequestParams
           class MandateOptions < Stripe::RequestParams
             # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
@@ -1554,6 +1641,8 @@ module Stripe
         attr_accessor :paypal
         # If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
         attr_accessor :payto
+        # If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
+        attr_accessor :pix
         # If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
         attr_accessor :sepa_debit
         # If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
@@ -1569,6 +1658,7 @@ module Stripe
           link: nil,
           paypal: nil,
           payto: nil,
+          pix: nil,
           sepa_debit: nil,
           us_bank_account: nil
         )
@@ -1581,6 +1671,7 @@ module Stripe
           @link = link
           @paypal = paypal
           @payto = payto
+          @pix = pix
           @sepa_debit = sepa_debit
           @us_bank_account = us_bank_account
         end
@@ -2678,6 +2769,53 @@ module Stripe
           end
         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
+          # Additional fields for mandate creation.
+          attr_accessor :mandate_options
+
+          def initialize(mandate_options: nil)
+            @mandate_options = mandate_options
+          end
+        end
+
         class SepaDebit < Stripe::RequestParams
           class MandateOptions < Stripe::RequestParams
             # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
@@ -2799,6 +2937,8 @@ module Stripe
         attr_accessor :paypal
         # If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
         attr_accessor :payto
+        # If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
+        attr_accessor :pix
         # If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
         attr_accessor :sepa_debit
         # If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
@@ -2814,6 +2954,7 @@ module Stripe
           link: nil,
           paypal: nil,
           payto: nil,
+          pix: nil,
           sepa_debit: nil,
           us_bank_account: nil
         )
@@ -2826,6 +2967,7 @@ module Stripe
           @link = link
           @paypal = paypal
           @payto = payto
+          @pix = pix
           @sepa_debit = sepa_debit
           @us_bank_account = us_bank_account
         end
@@ -3922,6 +4064,53 @@ module Stripe
           end
         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
+          # Additional fields for mandate creation.
+          attr_accessor :mandate_options
+
+          def initialize(mandate_options: nil)
+            @mandate_options = mandate_options
+          end
+        end
+
         class SepaDebit < Stripe::RequestParams
           class MandateOptions < Stripe::RequestParams
             # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
@@ -4043,6 +4232,8 @@ module Stripe
         attr_accessor :paypal
         # If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
         attr_accessor :payto
+        # If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
+        attr_accessor :pix
         # If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
         attr_accessor :sepa_debit
         # If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
@@ -4058,6 +4249,7 @@ module Stripe
           link: nil,
           paypal: nil,
           payto: nil,
+          pix: nil,
           sepa_debit: nil,
           us_bank_account: nil
         )
@@ -4070,6 +4262,7 @@ module Stripe
           @link = link
           @paypal = paypal
           @payto = payto
+          @pix = pix
           @sepa_debit = sepa_debit
           @us_bank_account = us_bank_account
         end

data/lib/stripe/resources/subscription.rb

@@ -343,6 +343,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
@@ -371,6 +406,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 current period of the subscription.
+        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.
@@ -380,8 +419,18 @@ module Stripe
         # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
         attr_accessor :tax_rates
 
-        def initialize(discounts: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil)
+        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
@@ -1137,9 +1186,9 @@ module Stripe
       attr_accessor :collection_method
       # Only return subscriptions that were created during the given date interval.
       attr_accessor :created
-      # Only return subscriptions whose current_period_end falls within the given date interval.
+      # Only return subscriptions whose minimum item current_period_end falls within the given date interval.
       attr_accessor :current_period_end
-      # Only return subscriptions whose current_period_start falls within the given date interval.
+      # Only return subscriptions whose maximum item current_period_start falls within the given date interval.
       attr_accessor :current_period_start
       # The ID of the customer whose subscriptions will be retrieved.
       attr_accessor :customer
@@ -1242,6 +1291,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
@@ -1270,6 +1354,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 current period of the subscription.
+        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.
@@ -1279,8 +1367,18 @@ module Stripe
         # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
         attr_accessor :tax_rates
 
-        def initialize(discounts: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil)
+        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
@@ -1312,15 +1410,15 @@ module Stripe
       end
 
       class BillingCycleAnchorConfig < Stripe::RequestParams
-        # The day of the month the billing_cycle_anchor should be. Ranges from 1 to 31.
+        # The day of the month the anchor should be. Ranges from 1 to 31.
         attr_accessor :day_of_month
-        # The hour of the day the billing_cycle_anchor should be. Ranges from 0 to 23.
+        # The hour of the day the anchor should be. Ranges from 0 to 23.
         attr_accessor :hour
-        # The minute of the hour the billing_cycle_anchor should be. Ranges from 0 to 59.
+        # The minute of the hour the anchor should be. Ranges from 0 to 59.
         attr_accessor :minute
-        # The month to start full cycle billing periods. Ranges from 1 to 12.
+        # The month to start full cycle periods. Ranges from 1 to 12.
         attr_accessor :month
-        # The second of the minute the billing_cycle_anchor should be. Ranges from 0 to 59.
+        # The second of the minute the anchor should be. Ranges from 0 to 59.
         attr_accessor :second
 
         def initialize(day_of_month: nil, hour: nil, minute: nil, month: nil, second: nil)