stripe 15.2.0.pre.beta.1 → 15.3.0.pre.beta.1

data/lib/stripe/services/balance_settings_service.rb

@@ -70,7 +70,7 @@ module Stripe
     end
 
     # Retrieves balance settings for a given connected account.
-    #  Related guide: [Making API calls for connected accounts](https://stripe.com/connect/authentication)
+    #  Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
     def retrieve(params = {}, opts = {})
       request(
         method: :get,
@@ -82,7 +82,7 @@ module Stripe
     end
 
     # Updates balance settings for a given connected account.
-    #  Related guide: [Making API calls for connected accounts](https://stripe.com/connect/authentication)
+    #  Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
     def update(params = {}, opts = {})
       request(
         method: :post,

data/lib/stripe/services/charge_service.rb

@@ -283,11 +283,29 @@ module Stripe
             end
           end
 
+          class Distance < Stripe::RequestParams
+            # Distance traveled.
+            attr_accessor :amount
+            # Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
+            attr_accessor :unit
+
+            def initialize(amount: nil, unit: nil)
+              @amount = amount
+              @unit = unit
+            end
+          end
+
           class Driver < Stripe::RequestParams
+            # Driver's identification number.
+            attr_accessor :driver_identification_number
+            # Driver's tax number.
+            attr_accessor :driver_tax_number
             # Full name of the person or entity on the car reservation.
             attr_accessor :name
 
-            def initialize(name: nil)
+            def initialize(driver_identification_number: nil, driver_tax_number: nil, name: nil)
+              @driver_identification_number = driver_identification_number
+              @driver_tax_number = driver_tax_number
               @name = name
             end
           end
@@ -371,6 +389,8 @@ module Stripe
           attr_accessor :days_rented
           # Delivery details for this purchase.
           attr_accessor :delivery
+          # The details of the distance traveled during the rental period.
+          attr_accessor :distance
           # The details of the passengers in the travel reservation
           attr_accessor :drivers
           # List of additional charges being billed.
@@ -381,6 +401,8 @@ module Stripe
           attr_accessor :pickup_address
           # Car pick-up time. Measured in seconds since the Unix epoch.
           attr_accessor :pickup_at
+          # Name of the pickup location.
+          attr_accessor :pickup_location_name
           # Rental rate.
           attr_accessor :rate_amount
           # The frequency at which the rate amount is applied. One of `day`, `week` or `month`
@@ -391,8 +413,12 @@ module Stripe
           attr_accessor :return_address
           # Car return time. Measured in seconds since the Unix epoch.
           attr_accessor :return_at
+          # Name of the return location.
+          attr_accessor :return_location_name
           # Indicates whether the goods or services are tax-exempt or tax is not collected.
           attr_accessor :tax_exempt
+          # The vehicle identification number.
+          attr_accessor :vehicle_identification_number
 
           def initialize(
             affiliate: nil,
@@ -404,17 +430,21 @@ module Stripe
             customer_service_phone_number: nil,
             days_rented: nil,
             delivery: nil,
+            distance: nil,
             drivers: nil,
             extra_charges: nil,
             no_show: nil,
             pickup_address: nil,
             pickup_at: nil,
+            pickup_location_name: nil,
             rate_amount: nil,
             rate_interval: nil,
             renter_name: nil,
             return_address: nil,
             return_at: nil,
-            tax_exempt: nil
+            return_location_name: nil,
+            tax_exempt: nil,
+            vehicle_identification_number: nil
           )
             @affiliate = affiliate
             @booking_number = booking_number
@@ -425,17 +455,21 @@ module Stripe
             @customer_service_phone_number = customer_service_phone_number
             @days_rented = days_rented
             @delivery = delivery
+            @distance = distance
             @drivers = drivers
             @extra_charges = extra_charges
             @no_show = no_show
             @pickup_address = pickup_address
             @pickup_at = pickup_at
+            @pickup_location_name = pickup_location_name
             @rate_amount = rate_amount
             @rate_interval = rate_interval
             @renter_name = renter_name
             @return_address = return_address
             @return_at = return_at
+            @return_location_name = return_location_name
             @tax_exempt = tax_exempt
+            @vehicle_identification_number = vehicle_identification_number
           end
         end
 
@@ -1065,11 +1099,29 @@ module Stripe
             end
           end
 
+          class Distance < Stripe::RequestParams
+            # Distance traveled.
+            attr_accessor :amount
+            # Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
+            attr_accessor :unit
+
+            def initialize(amount: nil, unit: nil)
+              @amount = amount
+              @unit = unit
+            end
+          end
+
           class Driver < Stripe::RequestParams
+            # Driver's identification number.
+            attr_accessor :driver_identification_number
+            # Driver's tax number.
+            attr_accessor :driver_tax_number
             # Full name of the person or entity on the car reservation.
             attr_accessor :name
 
-            def initialize(name: nil)
+            def initialize(driver_identification_number: nil, driver_tax_number: nil, name: nil)
+              @driver_identification_number = driver_identification_number
+              @driver_tax_number = driver_tax_number
               @name = name
             end
           end
@@ -1153,6 +1205,8 @@ module Stripe
           attr_accessor :days_rented
           # Delivery details for this purchase.
           attr_accessor :delivery
+          # The details of the distance traveled during the rental period.
+          attr_accessor :distance
           # The details of the passengers in the travel reservation
           attr_accessor :drivers
           # List of additional charges being billed.
@@ -1163,6 +1217,8 @@ module Stripe
           attr_accessor :pickup_address
           # Car pick-up time. Measured in seconds since the Unix epoch.
           attr_accessor :pickup_at
+          # Name of the pickup location.
+          attr_accessor :pickup_location_name
           # Rental rate.
           attr_accessor :rate_amount
           # The frequency at which the rate amount is applied. One of `day`, `week` or `month`
@@ -1173,8 +1229,12 @@ module Stripe
           attr_accessor :return_address
           # Car return time. Measured in seconds since the Unix epoch.
           attr_accessor :return_at
+          # Name of the return location.
+          attr_accessor :return_location_name
           # Indicates whether the goods or services are tax-exempt or tax is not collected.
           attr_accessor :tax_exempt
+          # The vehicle identification number.
+          attr_accessor :vehicle_identification_number
 
           def initialize(
             affiliate: nil,
@@ -1186,17 +1246,21 @@ module Stripe
             customer_service_phone_number: nil,
             days_rented: nil,
             delivery: nil,
+            distance: nil,
             drivers: nil,
             extra_charges: nil,
             no_show: nil,
             pickup_address: nil,
             pickup_at: nil,
+            pickup_location_name: nil,
             rate_amount: nil,
             rate_interval: nil,
             renter_name: nil,
             return_address: nil,
             return_at: nil,
-            tax_exempt: nil
+            return_location_name: nil,
+            tax_exempt: nil,
+            vehicle_identification_number: nil
           )
             @affiliate = affiliate
             @booking_number = booking_number
@@ -1207,17 +1271,21 @@ module Stripe
             @customer_service_phone_number = customer_service_phone_number
             @days_rented = days_rented
             @delivery = delivery
+            @distance = distance
             @drivers = drivers
             @extra_charges = extra_charges
             @no_show = no_show
             @pickup_address = pickup_address
             @pickup_at = pickup_at
+            @pickup_location_name = pickup_location_name
             @rate_amount = rate_amount
             @rate_interval = rate_interval
             @renter_name = renter_name
             @return_address = return_address
             @return_at = return_at
+            @return_location_name = return_location_name
             @tax_exempt = tax_exempt
+            @vehicle_identification_number = vehicle_identification_number
           end
         end
 
@@ -1757,9 +1825,9 @@ module Stripe
 
     # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
     #
-    # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
+    # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
     #
-    # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
+    # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture).
     def capture(charge, params = {}, opts = {})
       request(
         method: :post,
@@ -1770,7 +1838,7 @@ module Stripe
       )
     end
 
-    # This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents)
+    # This method is no longer recommended—use the [Payment Intents API](https://docs.stripe.com/docs/api/payment_intents)
     # to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
     # object used to request payment.
     def create(params = {}, opts = {})
@@ -1793,7 +1861,7 @@ module Stripe
       )
     end
 
-    # Search for charges you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+    # Search for charges you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
     # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
     # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
     # to an hour behind during outages. Search functionality is not available to merchants in India.

data/lib/stripe/services/checkout/session_service.rb

@@ -1322,8 +1322,7 @@ module Stripe
             end
           end
 
-          class PayByBank < Stripe::RequestParams
-          end
+          class PayByBank < Stripe::RequestParams; end
 
           class Payco < Stripe::RequestParams
             # Controls when the funds will be captured from the customer's account.
@@ -1812,11 +1811,18 @@ module Stripe
         class SavedPaymentMethodOptions < Stripe::RequestParams
           # Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
           attr_accessor :allow_redisplay_filters
+          # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
+          attr_accessor :payment_method_remove
           # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
           attr_accessor :payment_method_save
 
-          def initialize(allow_redisplay_filters: nil, payment_method_save: nil)
+          def initialize(
+            allow_redisplay_filters: nil,
+            payment_method_remove: nil,
+            payment_method_save: nil
+          )
             @allow_redisplay_filters = allow_redisplay_filters
+            @payment_method_remove = payment_method_remove
             @payment_method_save = payment_method_save
           end
         end
@@ -2005,7 +2011,7 @@ module Stripe
           attr_accessor :application_fee_percent
           # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
           attr_accessor :billing_cycle_anchor
-          # Configure billing_mode in each subscription to opt in improved credit proration behavior.
+          # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
           attr_accessor :billing_mode
           # The tax rates that will apply to any subscription item that does not have
           # `tax_rates` set. Invoices created will have their `default_tax_rates` populated
@@ -2495,7 +2501,7 @@ module Stripe
           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 when creating a new line item.
           attr_accessor :price_data
-          # The quantity of the line item being purchased.
+          # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
           attr_accessor :quantity
           # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
           attr_accessor :tax_rates
@@ -2636,7 +2642,7 @@ module Stripe
         #
         # To update an existing line item, specify its `id` along with the new values of the fields to update.
         #
-        # To add a new line item, specify a `price` and `quantity`.
+        # To add a new line item, specify one of `price` or `price_data` and `quantity`.
         #
         # To remove an existing line item, omit the line item's ID from the retransmitted array.
         #
@@ -2718,6 +2724,8 @@ module Stripe
       end
 
       # Updates a Checkout Session object.
+      #
+      # Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates)
       def update(session, params = {}, opts = {})
         request(
           method: :post,

data/lib/stripe/services/coupon_service.rb

@@ -3,8 +3,7 @@
 
 module Stripe
   class CouponService < StripeService
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.

data/lib/stripe/services/credit_note_service.rb

@@ -380,20 +380,19 @@ module Stripe
       end
     end
 
-    # Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
-    # its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
-    # in any combination of the following:
+    # Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
+    # This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
     #
     #
-    # Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
+    # Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
     # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
     # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
     #
     #
-    # For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
+    # The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
     #
-    # You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
-    # or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
+    # You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
+    # post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
     def create(params = {}, opts = {})
       request(
         method: :post,
@@ -448,7 +447,7 @@ module Stripe
       )
     end
 
-    # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
+    # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
     def void_credit_note(id, params = {}, opts = {})
       request(
         method: :post,

data/lib/stripe/services/customer_balance_transaction_service.rb

@@ -66,7 +66,7 @@ module Stripe
       end
     end
 
-    # Creates an immutable transaction that updates the customer's credit [balance](https://stripe.com/docs/billing/customer/balance).
+    # Creates an immutable transaction that updates the customer's credit [balance](https://docs.stripe.com/docs/billing/customer/balance).
     def create(customer, params = {}, opts = {})
       request(
         method: :post,
@@ -77,7 +77,7 @@ module Stripe
       )
     end
 
-    # Returns a list of transactions that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).
+    # Returns a list of transactions that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance).
     def list(customer, params = {}, opts = {})
       request(
         method: :get,
@@ -88,7 +88,7 @@ module Stripe
       )
     end
 
-    # Retrieves a specific customer balance transaction that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).
+    # Retrieves a specific customer balance transaction that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance).
     def retrieve(customer, transaction, params = {}, opts = {})
       request(
         method: :get,

data/lib/stripe/services/customer_cash_balance_transaction_service.rb

@@ -30,7 +30,7 @@ module Stripe
       end
     end
 
-    # Returns a list of transactions that modified the customer's [cash balance](https://stripe.com/docs/payments/customer-balance).
+    # Returns a list of transactions that modified the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance).
     def list(customer, params = {}, opts = {})
       request(
         method: :get,
@@ -41,7 +41,7 @@ module Stripe
       )
     end
 
-    # Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://stripe.com/docs/payments/customer-balance).
+    # Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance).
     def retrieve(customer, transaction, params = {}, opts = {})
       request(
         method: :get,

data/lib/stripe/services/customer_payment_source_service.rb

@@ -186,7 +186,7 @@ module Stripe
     #
     # If the card's owner has no default card, then the new card will become the default.
     # However, if the owner already has a default, then it will not change.
-    # To change the default, you should [update the customer](https://stripe.com/docs/api#update_customer) to have a new default_source.
+    # To change the default, you should [update the customer](https://docs.stripe.com/docs/api#update_customer) to have a new default_source.
     def create(customer, params = {}, opts = {})
       request(
         method: :post,

data/lib/stripe/services/customer_service.rb

@@ -16,8 +16,7 @@ module Stripe
       @funding_instructions = Stripe::CustomerFundingInstructionsService.new(@requestor)
     end
 
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
@@ -266,8 +265,7 @@ module Stripe
       end
     end
 
-    class DeleteDiscountParams < Stripe::RequestParams
-    end
+    class DeleteDiscountParams < Stripe::RequestParams; end
 
     class ListParams < Stripe::RequestParams
       class Created < Stripe::RequestParams
@@ -636,7 +634,7 @@ module Stripe
       )
     end
 
-    # Search for customers you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+    # Search for customers you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
     # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
     # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
     # to an hour behind during outages. Search functionality is not available to merchants in India.

data/lib/stripe/services/customer_tax_id_service.rb

@@ -3,8 +3,7 @@
 
 module Stripe
   class CustomerTaxIdService < StripeService
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.

data/lib/stripe/services/dispute_service.rb

@@ -408,7 +408,7 @@ module Stripe
 
     # When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
     #
-    # Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://stripe.com/docs/disputes/categories).
+    # Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://docs.stripe.com/docs/disputes/categories).
     def update(dispute, params = {}, opts = {})
       request(
         method: :post,

data/lib/stripe/services/external_account_service.rb

@@ -3,8 +3,7 @@
 
 module Stripe
   class ExternalAccountService < StripeService
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
@@ -301,7 +300,7 @@ module Stripe
     # a connected account and optionally sets it as the default for its currency. Other bank account
     # details are not editable by design.
     #
-    # You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection).
+    # You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
     #
     # You can re-enable a disabled bank account by performing an update call without providing any
     # arguments or changes.

data/lib/stripe/services/file_service.rb

@@ -110,7 +110,7 @@ module Stripe
       request(method: :get, path: "/v1/files", params: params, opts: opts, base_address: :api)
     end
 
-    # Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://stripe.com/docs/file-upload#download-file-contents).
+    # Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://docs.stripe.com/docs/file-upload#download-file-contents).
     def retrieve(file, params = {}, opts = {})
       request(
         method: :get,

data/lib/stripe/services/identity/verification_session_service.rb

@@ -243,9 +243,9 @@ module Stripe
         end
       end
 
-      # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
+      # A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
       #
-      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
+      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
       def cancel(session, params = {}, opts = {})
         request(
           method: :post,
@@ -262,7 +262,7 @@ module Stripe
       #
       # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
       #
-      # Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents)
+      # Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
       def create(params = {}, opts = {})
         request(
           method: :post,
@@ -289,7 +289,7 @@ module Stripe
       # request logs, etc.
       #
       # A VerificationSession object can be redacted when it is in requires_input or verified
-      # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
+      # [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
       # state will automatically cancel it.
       #
       # The redaction process may take up to four days. When the redaction process is in progress, the
@@ -302,7 +302,7 @@ module Stripe
       # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
       # used for any purpose.
       #
-      # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact).
+      # [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
       def redact(session, params = {}, opts = {})
         request(
           method: :post,

data/lib/stripe/services/invoice_item_service.rb

@@ -3,8 +3,7 @@
 
 module Stripe
   class InvoiceItemService < StripeService
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.