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

data/lib/stripe/services/setup_intent_service.rb

@@ -1096,6 +1096,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'.
@@ -1217,6 +1264,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.
@@ -1232,6 +1281,7 @@ module Stripe
           link: nil,
           paypal: nil,
           payto: nil,
+          pix: nil,
           sepa_debit: nil,
           us_bank_account: nil
         )
@@ -1244,6 +1294,7 @@ module Stripe
           @link = link
           @paypal = paypal
           @payto = payto
+          @pix = pix
           @sepa_debit = sepa_debit
           @us_bank_account = us_bank_account
         end
@@ -2353,6 +2404,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'.
@@ -2474,6 +2572,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.
@@ -2489,6 +2589,7 @@ module Stripe
           link: nil,
           paypal: nil,
           payto: nil,
+          pix: nil,
           sepa_debit: nil,
           us_bank_account: nil
         )
@@ -2501,6 +2602,7 @@ module Stripe
           @link = link
           @paypal = paypal
           @payto = payto
+          @pix = pix
           @sepa_debit = sepa_debit
           @us_bank_account = us_bank_account
         end
@@ -3597,6 +3699,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'.
@@ -3718,6 +3867,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.
@@ -3733,6 +3884,7 @@ module Stripe
           link: nil,
           paypal: nil,
           payto: nil,
+          pix: nil,
           sepa_debit: nil,
           us_bank_account: nil
         )
@@ -3745,6 +3897,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/services/subscription_schedule_service.rb

@@ -299,6 +299,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
@@ -327,6 +362,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.
@@ -336,8 +375,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
@@ -991,6 +1040,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
@@ -1019,6 +1103,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.
@@ -1028,8 +1116,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

data/lib/stripe/services/subscription_service.rb

@@ -86,6 +86,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
@@ -114,6 +149,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.
@@ -123,8 +162,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
@@ -880,9 +929,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
@@ -985,6 +1034,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
@@ -1013,6 +1097,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.
@@ -1022,8 +1110,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
@@ -1055,15 +1153,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)