stripe 23.0.0 → 23.1.0-alpha.2

package/esm/resources/BillingPortal/Sessions.d.ts

@@ -17,6 +17,10 @@ export interface Session {
      * String representing the object's type. Objects of the same type share the same value.
      */
     object: 'billing_portal.session';
+    /**
+     * Behavior after the portal session expires.
+     */
+    after_expiration?: Session.AfterExpiration | null;
     /**
      * The configuration used by this session, describing the features available.
      */
@@ -59,6 +63,16 @@ export interface Session {
     url: string;
 }
 export declare namespace Session {
+    interface AfterExpiration {
+        /**
+         * Configuration for authenticating the customer after the session expires.
+         */
+        customer_login: AfterExpiration.CustomerLogin | null;
+        /**
+         * The behavior to apply when the session expires.
+         */
+        type: AfterExpiration.Type;
+    }
     interface Flow {
         after_completion: Flow.AfterCompletion;
         /**
@@ -69,6 +83,10 @@ export declare namespace Session {
          * Configuration when `flow.type=subscription_cancel`.
          */
         subscription_cancel: Flow.SubscriptionCancel | null;
+        /**
+         * Configuration when `flow.type=subscription_pause`.
+         */
+        subscription_pause?: Flow.SubscriptionPause | null;
         /**
          * Configuration when `flow.type=subscription_update`.
          */
@@ -83,6 +101,15 @@ export declare namespace Session {
         type: Flow.Type;
     }
     type Locale = 'auto' | 'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-IE' | 'en-IN' | 'en-NZ' | 'en-SG' | 'es' | 'es-419' | 'et' | 'fi' | 'fil' | 'fr' | 'fr-CA' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'ms' | 'mt' | 'nb' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'sl' | 'sv' | 'th' | 'tr' | 'vi' | 'zh' | 'zh-HK' | 'zh-TW' | OtherString;
+    namespace AfterExpiration {
+        interface CustomerLogin {
+            /**
+             * The time after which the customer can no longer recover this session.
+             */
+            expires_at: number | null;
+        }
+        type Type = 'customer_login' | OtherString;
+    }
     namespace Flow {
         interface AfterCompletion {
             /**
@@ -110,6 +137,12 @@ export declare namespace Session {
              */
             subscription: string;
         }
+        interface SubscriptionPause {
+            /**
+             * The ID of the subscription to be paused.
+             */
+            subscription: string;
+        }
         interface SubscriptionUpdate {
             /**
              * The ID of the subscription to be updated.
@@ -130,7 +163,7 @@ export declare namespace Session {
              */
             subscription: string;
         }
-        type Type = 'customer_update' | 'payment_method_update' | 'subscription_cancel' | 'subscription_update' | 'subscription_update_confirm' | OtherString;
+        type Type = 'customer_update' | 'payment_method_update' | 'subscription_cancel' | 'subscription_pause' | 'subscription_update' | 'subscription_update_confirm' | OtherString;
         namespace AfterCompletion {
             interface HostedConfirmation {
                 /**
@@ -196,6 +229,10 @@ export declare namespace Session {
 }
 export declare namespace BillingPortal {
     interface SessionCreateParams {
+        /**
+         * Behavior after the portal session expires.
+         */
+        after_expiration?: SessionCreateParams.AfterExpiration;
         /**
          * The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configurations) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
          */
@@ -230,6 +267,16 @@ export declare namespace BillingPortal {
         return_url?: string;
     }
     namespace SessionCreateParams {
+        interface AfterExpiration {
+            /**
+             * Configuration for authenticating the customer after the session expires.
+             */
+            customer_login?: AfterExpiration.CustomerLogin;
+            /**
+             * The behavior to apply when the session expires.
+             */
+            type: AfterExpiration.Type;
+        }
         interface FlowData {
             /**
              * Behavior after the flow is completed.
@@ -239,6 +286,10 @@ export declare namespace BillingPortal {
              * Configuration when `flow_data.type=subscription_cancel`.
              */
             subscription_cancel?: FlowData.SubscriptionCancel;
+            /**
+             * Configuration when `flow_data.type=subscription_pause`.
+             */
+            subscription_pause?: FlowData.SubscriptionPause;
             /**
              * Configuration when `flow_data.type=subscription_update`.
              */
@@ -253,6 +304,15 @@ export declare namespace BillingPortal {
             type: FlowData.Type;
         }
         type Locale = 'auto' | 'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-IE' | 'en-IN' | 'en-NZ' | 'en-SG' | 'es' | 'es-419' | 'et' | 'fi' | 'fil' | 'fr' | 'fr-CA' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'ms' | 'mt' | 'nb' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'sl' | 'sv' | 'th' | 'tr' | 'vi' | 'zh' | 'zh-HK' | 'zh-TW' | OtherString;
+        namespace AfterExpiration {
+            interface CustomerLogin {
+                /**
+                 * The Unix timestamp after which the customer can no longer recover this session. Leave unset to allow recovery without a deadline.
+                 */
+                expires_at?: number;
+            }
+            type Type = 'customer_login' | OtherString;
+        }
         namespace FlowData {
             interface AfterCompletion {
                 /**
@@ -278,6 +338,12 @@ export declare namespace BillingPortal {
                  */
                 subscription: string;
             }
+            interface SubscriptionPause {
+                /**
+                 * The ID of the subscription to be paused.
+                 */
+                subscription: string;
+            }
             interface SubscriptionUpdate {
                 /**
                  * The ID of the subscription to be updated.
@@ -298,7 +364,7 @@ export declare namespace BillingPortal {
                  */
                 subscription: string;
             }
-            type Type = 'customer_update' | 'payment_method_update' | 'subscription_cancel' | 'subscription_update' | 'subscription_update_confirm' | OtherString;
+            type Type = 'customer_update' | 'payment_method_update' | 'subscription_cancel' | 'subscription_pause' | 'subscription_update' | 'subscription_update_confirm' | OtherString;
             namespace AfterCompletion {
                 interface HostedConfirmation {
                     /**

package/esm/resources/Capabilities.d.ts

@@ -14,6 +14,7 @@ export interface Capability {
      */
     account: string | Account;
     future_requirements?: Capability.FutureRequirements;
+    protections?: Capability.Protections;
     /**
      * Whether the capability has been requested.
      */
@@ -63,6 +64,9 @@ export declare namespace Capability {
          */
         pending_verification: Array<string>;
     }
+    interface Protections {
+        psp_migration?: Protections.PspMigration;
+    }
     interface Requirements {
         /**
          * 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.
@@ -115,6 +119,7 @@ export declare namespace Capability {
              * The code for the type of error.
              */
             code: Error.Code;
+            details?: Error.Details;
             /**
              * An informative message that indicates the error type and provides additional details about the error.
              */
@@ -125,7 +130,32 @@ export declare namespace Capability {
             requirement: string;
         }
         namespace Error {
-            type Code = 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_cmra_address' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_address_registered_agent_address' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_length' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'unsupported_business_type' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability';
+            type Code = 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_cmra_address' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_address_registered_agent_address' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_length' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'partner_disabled' | 'unsupported_business_type' | 'verification_data_not_found' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability';
+            interface Details {
+                /**
+                 * The rejection code as received from our payment method partner.
+                 */
+                partner_rejection_code?: string;
+            }
+        }
+    }
+    namespace Protections {
+        interface PspMigration {
+            /**
+             * Time at which the protection expires. Measured in seconds since the Unix epoch.
+             */
+            expires_at: number;
+            /**
+             * Time at which the protection was requested. Measured in seconds since the Unix epoch.
+             */
+            requested_at: number;
+            /**
+             * The status of the capability protection.
+             */
+            status: PspMigration.Status;
+        }
+        namespace PspMigration {
+            type Status = 'active' | 'disrupted' | 'expired' | 'inactive' | OtherString;
         }
     }
     namespace Requirements {
@@ -145,6 +175,7 @@ export declare namespace Capability {
              * The code for the type of error.
              */
             code: Error.Code;
+            details?: Error.Details;
             /**
              * An informative message that indicates the error type and provides additional details about the error.
              */
@@ -155,7 +186,13 @@ export declare namespace Capability {
             requirement: string;
         }
         namespace Error {
-            type Code = 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_cmra_address' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_address_registered_agent_address' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_length' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'unsupported_business_type' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability';
+            type Code = 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_cmra_address' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_address_registered_agent_address' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_length' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'partner_disabled' | 'unsupported_business_type' | 'verification_data_not_found' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability';
+            interface Details {
+                /**
+                 * The rejection code as received from our payment method partner.
+                 */
+                partner_rejection_code?: string;
+            }
         }
     }
 }

package/esm/resources/Capital/FinancingOffers.d.ts

@@ -0,0 +1,217 @@
+import { StripeResource } from '../../StripeResource.js';
+import { File } from './../Files.js';
+import { PaginationParams, RangeQueryParam, OtherString, Metadata } from '../../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../../lib.js';
+export declare class FinancingOfferResource extends StripeResource {
+    /**
+     * Retrieves the financing offers available for Connected accounts that belong to your platform.
+     */
+    list(params?: Capital.FinancingOfferListParams, options?: RequestOptions): ApiListPromise<FinancingOffer>;
+    /**
+     * Get the details of the financing offer
+     */
+    retrieve(id: string, params?: Capital.FinancingOfferRetrieveParams, options?: RequestOptions): Promise<Response<FinancingOffer>>;
+    /**
+     * Acknowledges that platform has received and delivered the financing_offer to
+     * the intended merchant recipient.
+     */
+    markDelivered(id: string, params?: Capital.FinancingOfferMarkDeliveredParams, options?: RequestOptions): Promise<Response<FinancingOffer>>;
+}
+export interface FinancingOffer {
+    /**
+     * A unique identifier for the financing object.
+     */
+    id: string;
+    /**
+     * The object type: financing_offer.
+     */
+    object: 'capital.financing_offer';
+    /**
+     * This is an object representing the terms of an offer of financing from
+     * Stripe Capital to a Connected account. This resource represents
+     * the terms accepted by the Connected account, which may differ from those
+     * offered.
+     */
+    accepted_terms?: FinancingOffer.AcceptedTerms;
+    /**
+     * The ID of the merchant associated with this financing object.
+     */
+    account: string;
+    /**
+     * The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
+     */
+    charged_off_at?: number;
+    /**
+     * Time at which the offer was created. Given in seconds since unix epoch.
+     */
+    created: number;
+    /**
+     * The type of disclaimer to use for a financing offer in user-facing surfaces. The corresponding disclaimer text to use for each disclaimer_variant value can be found in the [marketing docs](https://docs.stripe.com/capital/marketing).
+     */
+    disclaimer_variant?: FinancingOffer.DisclaimerVariant;
+    /**
+     * Time at which the offer expires. Given in seconds since unix epoch.
+     */
+    expires_after: number;
+    /**
+     * Documents associated with a financing offer.
+     */
+    financing_documents?: FinancingOffer.FinancingDocuments;
+    /**
+     * The type of financing being offered.
+     */
+    financing_type?: FinancingOffer.FinancingType;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * 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.
+     */
+    metadata?: Metadata;
+    /**
+     * This is an object representing the terms of an offer of financing from
+     * Stripe Capital to a Connected account. This resource represents
+     * both the terms offered to the Connected account.
+     */
+    offered_terms?: FinancingOffer.OfferedTerms;
+    /**
+     * Financing product identifier.
+     */
+    product_type?: FinancingOffer.ProductType;
+    /**
+     * The ID of the financing offer that replaced this offer.
+     */
+    replacement?: string;
+    /**
+     * The ID of the financing offer that this offer is a replacement for.
+     */
+    replacement_for?: string;
+    /**
+     * The current status of the offer.
+     */
+    status: FinancingOffer.Status;
+    /**
+     * See [financing_type](https://docs.stripe.com/api/capital/connect_financing_object#financing_offer_object-financing_type).
+     */
+    type?: FinancingOffer.Type;
+}
+export declare namespace FinancingOffer {
+    interface AcceptedTerms {
+        /**
+         * Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
+         */
+        advance_amount: number;
+        /**
+         * Currency that the financing offer is transacted in. For example, `usd`.
+         */
+        currency: string;
+        /**
+         * Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
+         */
+        fee_amount: number;
+        /**
+         * Populated when the `product_type` of the `financingoffer` is `refill`.
+         * Represents the discount amount on remaining premium for the existing loan at payout time.
+         */
+        previous_financing_fee_discount_amount: number | null;
+        /**
+         * Total amount due for the financing independent of what's already been paid, in minor units. For example, 100 USD is represented as 10000.
+         */
+        total_due_amount?: number;
+        /**
+         * Per-transaction rate at which Stripe withholds funds to repay the financing.
+         */
+        withhold_rate: number;
+    }
+    type DisclaimerVariant = 'celtic_us_loan' | 'fundbox_au_financing' | 'fundbox_ca_financing' | 'youlend_de_financing' | 'youlend_fr_financing' | 'youlend_uk_mca' | 'youlend_us_mca' | OtherString;
+    interface FinancingDocuments {
+        /**
+         * The primary contract that defines the financing provided to the connected account, including the funded amount, repayment terms, fees, and each party's obligations. Only available once the financing offer has been paid out.
+         */
+        financing_agreement: string | File | null;
+        /**
+         * A state-specific disclosure required by certain US states for sales-based financing. It supplements the main financing agreement and may be generated by Stripe or supplied by a financing partner, depending on the product.
+         */
+        state_sales_based_financing_agreement: string | File | null;
+        /**
+         * A partner-provided contract documenting the transfer or assignment of rights associated with the financing. It is separate from the main financing agreement, and a single financing may have multiple transfer agreements.
+         */
+        transfer_agreements: Array<string | File> | null;
+    }
+    type FinancingType = 'cash_advance' | 'flex_loan' | OtherString;
+    interface OfferedTerms {
+        /**
+         * Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
+         */
+        advance_amount: number;
+        /**
+         * Describes the type of user the offer is being extended to.
+         */
+        campaign_type: OfferedTerms.CampaignType;
+        /**
+         * Currency that the financing offer is transacted in. For example, `usd`.
+         */
+        currency: string;
+        /**
+         * Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
+         */
+        fee_amount: number;
+        /**
+         * Populated when the `product_type` of the `financingoffer` is `refill`.
+         * Represents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`
+         * is paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate
+         * and the remaining fee.
+         */
+        previous_financing_fee_discount_rate: number | null;
+        /**
+         * Per-transaction rate at which Stripe withholds funds to repay the financing.
+         */
+        withhold_rate: number;
+    }
+    type ProductType = 'refill' | 'standard' | OtherString;
+    type Status = 'accepted' | 'canceled' | 'completed' | 'delivered' | 'expired' | 'fully_repaid' | 'paid_out' | 'rejected' | 'replaced' | 'undelivered' | OtherString;
+    type Type = 'cash_advance' | 'fixed_term_loan' | 'flex_loan' | OtherString;
+    namespace OfferedTerms {
+        type CampaignType = 'newly_eligible_user' | 'previously_eligible_user' | 'repeat_user' | OtherString;
+    }
+}
+export declare namespace Capital {
+    interface FinancingOfferRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace Capital {
+    interface FinancingOfferListParams extends PaginationParams {
+        /**
+         * limit list to offers belonging to given connected account
+         */
+        connected_account?: string;
+        /**
+         * Only return offers that were created during the given date interval.
+         */
+        created?: RangeQueryParam | number;
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+        /**
+         * limit list to offers with given status
+         */
+        status?: FinancingOfferListParams.Status;
+    }
+    namespace FinancingOfferListParams {
+        type Status = 'accepted' | 'canceled' | 'completed' | 'delivered' | 'expired' | 'fully_repaid' | 'paid_out' | 'rejected' | 'revoked' | 'undelivered' | OtherString;
+    }
+}
+export declare namespace Capital {
+    interface FinancingOfferMarkDeliveredParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}

package/esm/resources/Capital/FinancingOffers.js

@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../StripeResource.js';
+export class FinancingOfferResource extends StripeResource {
+    /**
+     * Retrieves the financing offers available for Connected accounts that belong to your platform.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/capital/financing_offers', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Get the details of the financing offer
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/capital/financing_offers/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Acknowledges that platform has received and delivered the financing_offer to
+     * the intended merchant recipient.
+     */
+    markDelivered(id, params, options) {
+        return this._makeRequest('POST', `/v1/capital/financing_offers/${encodeURIComponent(id)}/mark_delivered`, params, options);
+    }
+}
+//# sourceMappingURL=FinancingOffers.js.map

package/esm/resources/Capital/FinancingOffers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FinancingOffers.js","sourceRoot":"","sources":["../../../src/resources/Capital/FinancingOffers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAUvD,MAAM,OAAO,sBAAuB,SAAQ,cAAc;IACxD;;OAEG;IACH,IAAI,CACF,MAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,8BAA8B,EAC9B,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,gCAAgC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACxD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,aAAa,CACX,EAAU,EACV,MAAkD,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,gCAAgC,kBAAkB,CAAC,EAAE,CAAC,iBAAiB,EACvE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}

package/esm/resources/Capital/FinancingSummary.d.ts

@@ -0,0 +1,123 @@
+import { StripeResource } from '../../StripeResource.js';
+import { OtherString } from '../../shared.js';
+import { RequestOptions, Response } from '../../lib.js';
+export declare class FinancingSummaryResource extends StripeResource {
+    /**
+     * Retrieve the financing summary object for the account.
+     */
+    retrieve(params?: Capital.FinancingSummaryRetrieveParams, options?: RequestOptions): Promise<Response<FinancingSummary>>;
+}
+export interface FinancingSummary {
+    /**
+     * The object type: financing_summary
+     */
+    object: 'capital.financing_summary';
+    /**
+     * 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 a `status` other than `none`.
+     */
+    details: FinancingSummary.Details | null;
+    /**
+     * The unique identifier of the Financing Offer object that corresponds to the Financing Summary object.
+     */
+    financing_offer: string | null;
+    /**
+     * The financing status of the connected account.
+     */
+    status: FinancingSummary.Status | null;
+}
+export declare namespace FinancingSummary {
+    interface Details {
+        /**
+         * Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
+         */
+        advance_amount: number;
+        /**
+         * The time at which the funds were paid out to the connected account's Stripe balance. Given in seconds since unix epoch.
+         */
+        advance_paid_out_at: number | null;
+        /**
+         * Currency that the financing offer is transacted in. For example, `usd`.
+         */
+        currency: string;
+        /**
+         * The chronologically current repayment interval for the financing offer.
+         */
+        current_repayment_interval: Details.CurrentRepaymentInterval | null;
+        /**
+         * The type of disclaimer to use for a financing offer in user-facing surfaces. The corresponding disclaimer text to use for each disclaimer_variant value can be found in the [regulatory compliance docs](https://docs.stripe.com/capital/regulatory-compliance).
+         */
+        disclaimer_variant?: Details.DisclaimerVariant;
+        /**
+         * The ways the connected account can pay toward its financing(s).
+         */
+        enabled_payment_types?: Array<Details.EnabledPaymentType>;
+        /**
+         * Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
+         */
+        fee_amount: number;
+        /**
+         * The overdue amount, in minor units. For example, 1,000 USD is represented as 100000. Defaults to null for legal cash advances.
+         */
+        overdue_amount?: number | null;
+        /**
+         * The amount the Connected account has paid toward the financing debt so far, in minor units. For example, 1,000 USD is represented as 100000.
+         */
+        paid_amount: number;
+        /**
+         * The balance remaining to be paid on the financing, in minor units. For example, 1,000 USD is represented as 100000.
+         */
+        remaining_amount: number;
+        /**
+         * The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
+         */
+        repayments_begin_at: number | null;
+        /**
+         * Total amount to be paid, independent of what's already been paid, in minor units. For example, 100 USD is represented as 10000.
+         */
+        total_due_amount?: number;
+        /**
+         * Per-transaction rate at which Stripe withholds funds to repay the financing.
+         */
+        withhold_rate: number;
+    }
+    type Status = 'accepted' | 'delivered' | 'none' | OtherString;
+    namespace Details {
+        interface CurrentRepaymentInterval {
+            /**
+             * The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.
+             * Given in seconds since unix epoch.
+             */
+            due_at: number;
+            /**
+             * The balance for the current repayment interval, in minor units. This does not account for any amount paid down during the interval.
+             */
+            incremental_interval_target_amount?: number;
+            /**
+             * The amount that has already been paid in the current repayment interval, in minor units. For example, 100 USD is represented as 10000.
+             */
+            paid_amount: number | null;
+            /**
+             * The amount that is yet to be paid in the current repayment interval, in minor units. For example, 100 USD is represented as 10000.
+             */
+            remaining_amount: number;
+            /**
+             * The time at which the current repayment interval started. Given in seconds since unix epoch.
+             */
+            starts_at?: number;
+        }
+        type DisclaimerVariant = 'celtic_us_loan' | 'fundbox_au_financing' | 'fundbox_ca_financing' | 'youlend_de_financing' | 'youlend_fr_financing' | 'youlend_uk_mca' | 'youlend_us_mca' | OtherString;
+        type EnabledPaymentType = 'automatic_debits' | 'manual_payment' | 'withholding' | OtherString;
+    }
+}
+export declare namespace Capital {
+    interface FinancingSummaryRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}

package/esm/resources/Capital/FinancingSummary.js

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../StripeResource.js';
+export class FinancingSummaryResource extends StripeResource {
+    /**
+     * Retrieve the financing summary object for the account.
+     */
+    retrieve(params, options) {
+        return this._makeRequest('GET', '/v1/capital/financing_summary', params, options);
+    }
+}
+//# sourceMappingURL=FinancingSummary.js.map

package/esm/resources/Capital/FinancingSummary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FinancingSummary.js","sourceRoot":"","sources":["../../../src/resources/Capital/FinancingSummary.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAIvD,MAAM,OAAO,wBAAyB,SAAQ,cAAc;IAC1D;;OAEG;IACH,QAAQ,CACN,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,+BAA+B,EAC/B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}