stripe 18.1.0.pre.beta.1 → 18.2.0.pre.alpha.1

data/lib/stripe/resources/billing_portal/session.rb

@@ -139,11 +139,11 @@ module Stripe
           end
 
           class Item < ::Stripe::StripeObject
-            # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+            # The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated.
             attr_reader :id
-            # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
+            # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
             attr_reader :price
-            # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+            # [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
             attr_reader :quantity
 
             def self.inner_class_types
@@ -156,7 +156,7 @@ module Stripe
           end
           # The coupon or promotion code to apply to this subscription update.
           attr_reader :discounts
-          # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
+          # The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
           attr_reader :items
           # The ID of the subscription to be updated.
           attr_reader :subscription
@@ -201,7 +201,7 @@ module Stripe
       attr_reader :customer
       # The ID of the account for this session.
       attr_reader :customer_account
-      # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
+      # Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
       attr_reader :flow
       # Unique identifier for the object.
       attr_reader :id
@@ -211,7 +211,7 @@ module Stripe
       attr_reader :locale
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
-      # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
+      # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
       attr_reader :on_behalf_of
       # The URL to redirect customers to when they click on the portal's link to return to your website.
       attr_reader :return_url

data/lib/stripe/resources/capability.rb

@@ -4,7 +4,7 @@
 module Stripe
   # This is an object representing a capability for a Stripe account.
   #
-  # Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
+  # Related guide: [Account capabilities](https://docs.stripe.com/connect/account-capabilities)
   class Capability < APIResource
     include Stripe::APIOperations::Save
 
@@ -15,9 +15,9 @@ module Stripe
 
     class FutureRequirements < ::Stripe::StripeObject
       class Alternative < ::Stripe::StripeObject
-        # Fields that can be provided to satisfy all fields in `original_fields_due`.
+        # Fields that can be provided to resolve all fields in `original_fields_due`.
         attr_reader :alternative_fields_due
-        # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
+        # Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
         attr_reader :original_fields_due
 
         def self.inner_class_types
@@ -45,21 +45,21 @@ module Stripe
           @field_remappings = {}
         end
       end
-      # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
+      # Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields.
       attr_reader :alternatives
       # Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
       attr_reader :current_deadline
-      # Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
+      # Fields that need to be resolved to keep the capability enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
       attr_reader :currently_due
       # This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.
       attr_reader :disabled_reason
-      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      # Details about validation and verification failures for `due` requirements that must be resolved.
       attr_reader :errors
       # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
       attr_reader :eventually_due
-      # Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
+      # Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`.
       attr_reader :past_due
-      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
+      # Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
       attr_reader :pending_verification
 
       def self.inner_class_types
@@ -73,9 +73,9 @@ module Stripe
 
     class Requirements < ::Stripe::StripeObject
       class Alternative < ::Stripe::StripeObject
-        # Fields that can be provided to satisfy all fields in `original_fields_due`.
+        # Fields that can be provided to resolve all fields in `original_fields_due`.
         attr_reader :alternative_fields_due
-        # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
+        # Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
         attr_reader :original_fields_due
 
         def self.inner_class_types
@@ -103,21 +103,21 @@ module Stripe
           @field_remappings = {}
         end
       end
-      # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
+      # Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields.
       attr_reader :alternatives
       # The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested.
       attr_reader :current_deadline
-      # Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.
+      # Fields that need to be resolved to keep the capability enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the capability is disabled.
       attr_reader :currently_due
-      # Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).
+      # Description of why the capability is disabled. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification).
       attr_reader :disabled_reason
-      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      # Details about validation and verification failures for `due` requirements that must be resolved.
       attr_reader :errors
       # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
       attr_reader :eventually_due
-      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.
+      # Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the capability on the account.
       attr_reader :past_due
-      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      # Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
       attr_reader :pending_verification
 
       def self.inner_class_types

data/lib/stripe/resources/capital/financing_offer.rb

@@ -79,7 +79,7 @@ module Stripe
       attr_reader :id
       # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
       attr_reader :livemode
-      # 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.
+      # Set of [key-value pairs](https://docs.stripe.com/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
       # The object type: financing_offer.
       attr_reader :object
@@ -95,7 +95,7 @@ module Stripe
       attr_reader :replacement_for
       # The current status of the offer.
       attr_reader :status
-      # See [financing_type](https://stripe.com/docs/api/capital/connect_financing_object#financing_offer_object-financing_type).
+      # See [financing_type](https://docs.stripe.com/api/capital/connect_financing_object#financing_offer_object-financing_type).
       attr_reader :type
 
       # Retrieves the financing offers available for Connected accounts that belong to your platform.
@@ -130,6 +130,47 @@ module Stripe
         )
       end
 
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = FinancingOffer
+        def self.resource_class
+          "FinancingOffer"
+        end
+
+        # Creates a test financing offer for a connected account.
+        def self.create(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/capital/financing_offers",
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Refills a test financing offer for a connected account.
+        def self.refill(financing_offer, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/capital/financing_offers/%<financing_offer>s/refill", { financing_offer: CGI.escape(financing_offer) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Refills a test financing offer for a connected account.
+        def refill(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/capital/financing_offers/%<financing_offer>s/refill", { financing_offer: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
+
       def self.inner_class_types
         @inner_class_types = { accepted_terms: AcceptedTerms, offered_terms: OfferedTerms }
       end

data/lib/stripe/resources/capital/financing_summary.rb

@@ -3,8 +3,9 @@
 
 module Stripe
   module Capital
-    # A financing object describes an account's current financing state. Used by Connect
-    # platforms to read the state of Capital offered to their connected accounts.
+    # A financing summary object describes a connected account's financing status in real time.
+    # A financing status is either `accepted`, `delivered`, or `none`.
+    # You can read the status of your connected accounts.
     class FinancingSummary < SingletonAPIResource
       OBJECT_NAME = "capital.financing_summary"
       def self.object_name
@@ -59,12 +60,14 @@ module Stripe
       # Additional information about the financing summary. Describes currency, advance amount,
       # fee amount, withhold rate, remaining amount, paid amount, current repayment interval,
       # repayment start date, and advance payout date.
+      #
+      # Only present for financing offers with the `paid_out` status.
       attr_reader :details
-      # The Financing Offer ID this Financing Summary corresponds to
+      # The unique identifier of the Financing Offer object that corresponds to the Financing Summary object.
       attr_reader :financing_offer
       # The object type: financing_summary
       attr_reader :object
-      # Status of the Connected Account's financing. [/v1/capital/financing_summary](https://stripe.com/docs/api/capital/financing_summary) will only return `details` for `paid_out` financing.
+      # The financing status of the connected account.
       attr_reader :status
 
       def self.inner_class_types

data/lib/stripe/resources/card.rb

@@ -6,7 +6,7 @@ module Stripe
   # later. You can also store multiple debit cards on a recipient in order to
   # transfer to those cards later.
   #
-  # Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
+  # Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards)
   class Card < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
@@ -17,6 +17,21 @@ module Stripe
       "card"
     end
 
+    class Benefits < ::Stripe::StripeObject
+      # Issuer of this benefit card
+      attr_reader :issuer
+      # Available benefit programs for this card
+      attr_reader :programs
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class Networks < ::Stripe::StripeObject
       # The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.
       attr_reader :preferred
@@ -51,6 +66,8 @@ module Stripe
     attr_reader :allow_redisplay
     # A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.
     attr_reader :available_payout_methods
+    # Attribute for field benefits
+    attr_reader :benefits
     # Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
     attr_reader :brand
     # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
@@ -87,7 +104,7 @@ module Stripe
     attr_reader :issuer
     # The last four digits of the card.
     attr_reader :last4
-    # 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.
+    # Set of [key-value pairs](https://docs.stripe.com/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
     # Cardholder name.
     attr_reader :name
@@ -154,7 +171,7 @@ module Stripe
     end
 
     def self.inner_class_types
-      @inner_class_types = { networks: Networks }
+      @inner_class_types = { benefits: Benefits, networks: Networks }
     end
 
     def self.field_remappings

data/lib/stripe/resources/cash_balance.rb

@@ -23,11 +23,11 @@ module Stripe
         @field_remappings = {}
       end
     end
-    # A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+    # A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
     attr_reader :available
     # The ID of the customer whose cash balance this object represents.
     attr_reader :customer
-    # The ID of the account whose cash balance this object represents.
+    # The ID of an Account representing a customer whose cash balance this object represents.
     attr_reader :customer_account
     # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
     attr_reader :livemode