stripe 13.6.0.pre.beta.1 → 14.0.0

data/lib/stripe/resources/payment_method_domain.rb

@@ -74,7 +74,7 @@ module Stripe
     class ListParams < Stripe::RequestParams
       # The domain name that this payment method domain object represents.
       attr_accessor :domain_name
-      # Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements
+      # Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout
       attr_accessor :enabled
       # 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
@@ -105,7 +105,7 @@ module Stripe
     class CreateParams < Stripe::RequestParams
       # The domain name that this payment method domain object represents.
       attr_accessor :domain_name
-      # Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
+      # Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
       attr_accessor :enabled
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
@@ -117,17 +117,8 @@ module Stripe
       end
     end
 
-    class RetrieveParams < Stripe::RequestParams
-      # Specifies which fields in the response should be expanded.
-      attr_accessor :expand
-
-      def initialize(expand: nil)
-        @expand = expand
-      end
-    end
-
     class UpdateParams < Stripe::RequestParams
-      # Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
+      # Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
       attr_accessor :enabled
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
@@ -199,10 +190,10 @@ module Stripe
       )
     end
 
-    # Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
-    # The payment method doesn't appear in Elements for this domain until it is active.
+    # Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
+    # The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
     #
-    # To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.
+    # To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
     #
     # Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
     def validate(params = {}, opts = {})
@@ -214,10 +205,10 @@ module Stripe
       )
     end
 
-    # Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
-    # The payment method doesn't appear in Elements for this domain until it is active.
+    # Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
+    # The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
     #
-    # To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.
+    # To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
     #
     # Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
     def self.validate(payment_method_domain, params = {}, opts = {})

data/lib/stripe/resources/payout.rb

@@ -144,15 +144,6 @@ module Stripe
       end
     end
 
-    class RetrieveParams < Stripe::RequestParams
-      # Specifies which fields in the response should be expanded.
-      attr_accessor :expand
-
-      def initialize(expand: nil)
-        @expand = expand
-      end
-    end
-
     class UpdateParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand

data/lib/stripe/resources/person.rb

@@ -4,7 +4,7 @@
 module Stripe
   # This is an object representing a person associated with a Stripe account.
   #
-  # A platform cannot access a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
+  # A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
   #
   # See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information).
   class Person < APIResource
@@ -227,15 +227,15 @@ module Stripe
     attr_reader :created
     # Attribute for field dob
     attr_reader :dob
-    # The person's email address.
+    # The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
     attr_reader :email
-    # The person's first name.
+    # The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
     attr_reader :first_name
-    # The Kana variation of the person's first name (Japan only).
+    # The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
     attr_reader :first_name_kana
-    # The Kanji variation of the person's first name (Japan only).
+    # The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
     attr_reader :first_name_kanji
-    # A list of alternate names or aliases that the person is known by.
+    # A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
     attr_reader :full_name_aliases
     # Information about the [upcoming new requirements for this person](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
     attr_reader :future_requirements
@@ -247,11 +247,11 @@ module Stripe
     attr_reader :id_number_provided
     # Whether the person's `id_number_secondary` was provided.
     attr_reader :id_number_secondary_provided
-    # The person's last name.
+    # The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
     attr_reader :last_name
-    # The Kana variation of the person's last name (Japan only).
+    # The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
     attr_reader :last_name_kana
-    # The Kanji variation of the person's last name (Japan only).
+    # The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
     attr_reader :last_name_kanji
     # The person's maiden name.
     attr_reader :maiden_name

data/lib/stripe/resources/plan.rb

@@ -44,15 +44,6 @@ module Stripe
     class DeleteParams < Stripe::RequestParams
     end
 
-    class RetrieveParams < Stripe::RequestParams
-      # Specifies which fields in the response should be expanded.
-      attr_accessor :expand
-
-      def initialize(expand: nil)
-        @expand = expand
-      end
-    end
-
     class UpdateParams < Stripe::RequestParams
       # Whether the plan is currently available for new subscriptions.
       attr_accessor :active
@@ -214,8 +205,6 @@ module Stripe
       end
       # Whether the plan is currently available for new subscriptions. Defaults to `true`.
       attr_accessor :active
-      # Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.
-      attr_accessor :aggregate_usage
       # A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.
       attr_accessor :amount
       # Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.
@@ -253,7 +242,6 @@ module Stripe
 
       def initialize(
         active: nil,
-        aggregate_usage: nil,
         amount: nil,
         amount_decimal: nil,
         billing_scheme: nil,
@@ -273,7 +261,6 @@ module Stripe
         usage_type: nil
       )
         @active = active
-        @aggregate_usage = aggregate_usage
         @amount = amount
         @amount_decimal = amount_decimal
         @billing_scheme = billing_scheme
@@ -295,8 +282,6 @@ module Stripe
     end
     # Whether the plan can be used for new purchases.
     attr_reader :active
-    # Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.
-    attr_reader :aggregate_usage
     # The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
     attr_reader :amount
     # The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.

data/lib/stripe/resources/price.rb

@@ -62,18 +62,7 @@ module Stripe
       attr_reader :preset
     end
 
-    class MigrateTo < Stripe::StripeObject
-      # The behavior controlling at what point in the subscription lifecycle to migrate the price
-      attr_reader :behavior
-      # The unix timestamp after at which subscriptions will start to migrate to the new price.
-      attr_reader :effective_after
-      # The id of the price being migrated to
-      attr_reader :price
-    end
-
     class Recurring < Stripe::StripeObject
-      # Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.
-      attr_reader :aggregate_usage
       # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
       attr_reader :interval
       # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
@@ -317,8 +306,6 @@ module Stripe
       end
 
       class Recurring < Stripe::RequestParams
-        # Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.
-        attr_accessor :aggregate_usage
         # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
         attr_accessor :interval
         # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
@@ -331,14 +318,12 @@ module Stripe
         attr_accessor :usage_type
 
         def initialize(
-          aggregate_usage: nil,
           interval: nil,
           interval_count: nil,
           meter: nil,
           trial_period_days: nil,
           usage_type: nil
         )
-          @aggregate_usage = aggregate_usage
           @interval = interval
           @interval_count = interval_count
           @meter = meter
@@ -403,7 +388,7 @@ module Stripe
       attr_accessor :metadata
       # A brief description of the price, hidden from customers.
       attr_accessor :nickname
-      # The ID of the product that this price will belong to.
+      # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
       attr_accessor :product
       # These fields can be used to create a new product that this price will belong to.
       attr_accessor :product_data
@@ -467,15 +452,6 @@ module Stripe
       end
     end
 
-    class RetrieveParams < Stripe::RequestParams
-      # Specifies which fields in the response should be expanded.
-      attr_accessor :expand
-
-      def initialize(expand: nil)
-        @expand = expand
-      end
-    end
-
     class UpdateParams < Stripe::RequestParams
       class CurrencyOptions < Stripe::RequestParams
         class CustomUnitAmount < Stripe::RequestParams
@@ -547,21 +523,6 @@ 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).
@@ -572,8 +533,6 @@ 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.
@@ -587,7 +546,6 @@ module Stripe
         expand: nil,
         lookup_key: nil,
         metadata: nil,
-        migrate_to: nil,
         nickname: nil,
         tax_behavior: nil,
         transfer_lookup_key: nil
@@ -597,7 +555,6 @@ 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
@@ -641,8 +598,6 @@ module Stripe
     attr_reader :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.
     attr_reader :metadata
-    # Subscriptions using this price will be migrated to use the new referenced price.
-    attr_reader :migrate_to
     # A brief description of the price, hidden from customers.
     attr_reader :nickname
     # String representing the object's type. Objects of the same type share the same value.
@@ -668,7 +623,7 @@ module Stripe
     # Always true for a deleted object
     attr_reader :deleted
 
-    # Creates a new price for an existing product. The price can be recurring or one-time.
+    # Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/prices", params: params, opts: opts)
     end

data/lib/stripe/resources/product.rb

@@ -41,37 +41,9 @@ module Stripe
       attr_reader :width
     end
 
-    class Provisioning < Stripe::StripeObject
-      class GiftCard < Stripe::StripeObject
-        class FixedAmount < Stripe::StripeObject
-          # The initial amount with which the provisioned gift card will be created.
-          attr_reader :amount
-          # 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_reader :currency
-        end
-        # Attribute for field fixed_amount
-        attr_reader :fixed_amount
-        # The specific type of gift_card provisioning, only `fixed_amount` currently supported.
-        attr_reader :type
-      end
-      # Attribute for field gift_card
-      attr_reader :gift_card
-      # The type of provisioning, only `gift_card` currently supported.
-      attr_reader :type
-    end
-
     class DeleteParams < Stripe::RequestParams
     end
 
-    class RetrieveParams < Stripe::RequestParams
-      # Specifies which fields in the response should be expanded.
-      attr_accessor :expand
-
-      def initialize(expand: nil)
-        @expand = expand
-      end
-    end
-
     class UpdateParams < Stripe::RequestParams
       class MarketingFeature < Stripe::RequestParams
         # The marketing feature name. Up to 80 characters long.
@@ -394,40 +366,6 @@ module Stripe
           @width = width
         end
       end
-
-      class Provisioning < Stripe::RequestParams
-        class GiftCard < Stripe::RequestParams
-          class FixedAmount < Stripe::RequestParams
-            # The initial amount with which the provisioned gift card will be created.
-            attr_accessor :amount
-            # Attribute for param field currency
-            attr_accessor :currency
-
-            def initialize(amount: nil, currency: nil)
-              @amount = amount
-              @currency = currency
-            end
-          end
-          # Attribute for param field fixed_amount
-          attr_accessor :fixed_amount
-          # The specific type of gift_card provisioning, only `fixed_amount` currently supported.
-          attr_accessor :type
-
-          def initialize(fixed_amount: nil, type: nil)
-            @fixed_amount = fixed_amount
-            @type = type
-          end
-        end
-        # Attribute for param field gift_card
-        attr_accessor :gift_card
-        # The type of provisioning, only `gift_card` currently supported.
-        attr_accessor :type
-
-        def initialize(gift_card: nil, type: nil)
-          @gift_card = gift_card
-          @type = type
-        end
-      end
       # Whether the product is currently available for purchase. Defaults to `true`.
       attr_accessor :active
       # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.
@@ -448,8 +386,6 @@ module Stripe
       attr_accessor :name
       # The dimensions of this product for shipping purposes.
       attr_accessor :package_dimensions
-      # Provisioning configuration for this product.
-      attr_accessor :provisioning
       # Whether this product is shipped (i.e., physical goods).
       attr_accessor :shippable
       # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
@@ -477,7 +413,6 @@ module Stripe
         metadata: nil,
         name: nil,
         package_dimensions: nil,
-        provisioning: nil,
         shippable: nil,
         statement_descriptor: nil,
         tax_code: nil,
@@ -495,7 +430,6 @@ module Stripe
         @metadata = metadata
         @name = name
         @package_dimensions = package_dimensions
-        @provisioning = provisioning
         @shippable = shippable
         @statement_descriptor = statement_descriptor
         @tax_code = tax_code
@@ -546,8 +480,6 @@ module Stripe
     attr_reader :object
     # The dimensions of this product for shipping purposes.
     attr_reader :package_dimensions
-    # Provisioning configuration for this product.
-    attr_reader :provisioning
     # Whether this product is shipped (i.e., physical goods).
     attr_reader :shippable
     # Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.

data/lib/stripe/resources/promotion_code.rb

@@ -164,15 +164,6 @@ module Stripe
       end
     end
 
-    class RetrieveParams < Stripe::RequestParams
-      # Specifies which fields in the response should be expanded.
-      attr_accessor :expand
-
-      def initialize(expand: nil)
-        @expand = expand
-      end
-    end
-
     class UpdateParams < Stripe::RequestParams
       class Restrictions < Stripe::RequestParams
         class CurrencyOptions < Stripe::RequestParams