stripe 21.1.0-beta.2 → 22.0.1

package/esm/resources/BillingPortal/Configurations.js

@@ -1,22 +1,31 @@
 // File generated from our OpenAPI spec
 import { StripeResource } from '../../StripeResource.js';
-const stripeMethod = StripeResource.method;
-export const Configurations = StripeResource.extend({
-    create: stripeMethod({
-        method: 'POST',
-        fullPath: '/v1/billing_portal/configurations',
-    }),
-    retrieve: stripeMethod({
-        method: 'GET',
-        fullPath: '/v1/billing_portal/configurations/{configuration}',
-    }),
-    update: stripeMethod({
-        method: 'POST',
-        fullPath: '/v1/billing_portal/configurations/{configuration}',
-    }),
-    list: stripeMethod({
-        method: 'GET',
-        fullPath: '/v1/billing_portal/configurations',
-        methodType: 'list',
-    }),
-});
+export class ConfigurationResource extends StripeResource {
+    /**
+     * Returns a list of configurations that describe the functionality of the customer portal.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/billing_portal/configurations', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Creates a configuration that describes the functionality and behavior of a PortalSession
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/billing_portal/configurations', params, options);
+    }
+    /**
+     * Retrieves a configuration that describes the functionality of the customer portal.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/billing_portal/configurations/${id}`, params, options);
+    }
+    /**
+     * Updates a configuration that describes the functionality of the customer portal.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v1/billing_portal/configurations/${id}`, params, options);
+    }
+}
+//# sourceMappingURL=Configurations.js.map

package/esm/resources/BillingPortal/Configurations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Configurations.js","sourceRoot":"","sources":["../../../src/resources/BillingPortal/Configurations.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAUvD,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IACvD;;OAEG;IACH,IAAI,CACF,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,mCAAmC,EACnC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,mCAAmC,EACnC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkD,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qCAAqC,EAAE,EAAE,EACzC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAgD,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,qCAAqC,EAAE,EAAE,EACzC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}

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

@@ -0,0 +1,360 @@
+import { StripeResource } from '../../StripeResource.js';
+import { Configuration } from './Configurations.js';
+import { RequestOptions, Response } from '../../lib.js';
+export declare class SessionResource extends StripeResource {
+    /**
+     * Creates a session of the customer portal.
+     */
+    create(params?: BillingPortal.SessionCreateParams, options?: RequestOptions): Promise<Response<Session>>;
+}
+export interface Session {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'billing_portal.session';
+    /**
+     * The configuration used by this session, describing the features available.
+     */
+    configuration: string | Configuration;
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+    /**
+     * The ID of the customer for this session.
+     */
+    customer: string;
+    /**
+     * The ID of the account for this session.
+     */
+    customer_account: string | null;
+    /**
+     * 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.
+     */
+    flow: BillingPortal.Session.Flow | null;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer's `preferred_locales` or browser's locale is used.
+     */
+    locale: BillingPortal.Session.Locale | null;
+    /**
+     * 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.
+     */
+    on_behalf_of: string | null;
+    /**
+     * The URL to redirect customers to when they click on the portal's link to return to your website.
+     */
+    return_url: string | null;
+    /**
+     * The short-lived URL of the session that gives customers access to the customer portal.
+     */
+    url: string;
+}
+export declare namespace BillingPortal {
+    namespace Session {
+        interface Flow {
+            after_completion: Flow.AfterCompletion;
+            /**
+             * Configuration when `flow.type=subscription_cancel`.
+             */
+            subscription_cancel: Flow.SubscriptionCancel | null;
+            /**
+             * Configuration when `flow.type=subscription_update`.
+             */
+            subscription_update: Flow.SubscriptionUpdate | null;
+            /**
+             * Configuration when `flow.type=subscription_update_confirm`.
+             */
+            subscription_update_confirm: Flow.SubscriptionUpdateConfirm | null;
+            /**
+             * Type of flow that the customer will go through.
+             */
+            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';
+        namespace Flow {
+            interface AfterCompletion {
+                /**
+                 * Configuration when `after_completion.type=hosted_confirmation`.
+                 */
+                hosted_confirmation: AfterCompletion.HostedConfirmation | null;
+                /**
+                 * Configuration when `after_completion.type=redirect`.
+                 */
+                redirect: AfterCompletion.Redirect | null;
+                /**
+                 * The specified type of behavior after the flow is completed.
+                 */
+                type: AfterCompletion.Type;
+            }
+            interface SubscriptionCancel {
+                /**
+                 * Specify a retention strategy to be used in the cancellation flow.
+                 */
+                retention: SubscriptionCancel.Retention | null;
+                /**
+                 * The ID of the subscription to be canceled.
+                 */
+                subscription: string;
+            }
+            interface SubscriptionUpdate {
+                /**
+                 * The ID of the subscription to be updated.
+                 */
+                subscription: string;
+            }
+            interface SubscriptionUpdateConfirm {
+                /**
+                 * The coupon or promotion code to apply to this subscription update.
+                 */
+                discounts: Array<SubscriptionUpdateConfirm.Discount> | null;
+                /**
+                 * 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.
+                 */
+                items: Array<SubscriptionUpdateConfirm.Item>;
+                /**
+                 * The ID of the subscription to be updated.
+                 */
+                subscription: string;
+            }
+            type Type = 'payment_method_update' | 'subscription_cancel' | 'subscription_update' | 'subscription_update_confirm';
+            namespace AfterCompletion {
+                interface HostedConfirmation {
+                    /**
+                     * A custom message to display to the customer after the flow is completed.
+                     */
+                    custom_message: string | null;
+                }
+                interface Redirect {
+                    /**
+                     * The URL the customer will be redirected to after the flow is completed.
+                     */
+                    return_url: string;
+                }
+                type Type = 'hosted_confirmation' | 'portal_homepage' | 'redirect';
+            }
+            namespace SubscriptionCancel {
+                interface Retention {
+                    /**
+                     * Configuration when `retention.type=coupon_offer`.
+                     */
+                    coupon_offer: Retention.CouponOffer | null;
+                    /**
+                     * Type of retention strategy that will be used.
+                     */
+                    type: 'coupon_offer';
+                }
+                namespace Retention {
+                    interface CouponOffer {
+                        /**
+                         * The ID of the coupon to be offered.
+                         */
+                        coupon: string;
+                    }
+                }
+            }
+            namespace SubscriptionUpdateConfirm {
+                interface Discount {
+                    /**
+                     * The ID of the coupon to apply to this subscription update.
+                     */
+                    coupon: string | null;
+                    /**
+                     * The ID of a promotion code to apply to this subscription update.
+                     */
+                    promotion_code: string | null;
+                }
+                interface Item {
+                    /**
+                     * The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+                     */
+                    id: string | null;
+                    /**
+                     * 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).
+                     */
+                    price: string | null;
+                    /**
+                     * [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+                     */
+                    quantity?: number;
+                }
+            }
+        }
+    }
+}
+export declare namespace BillingPortal {
+    interface SessionCreateParams {
+        /**
+         * 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.
+         */
+        configuration?: string;
+        /**
+         * The ID of an existing customer.
+         */
+        customer?: string;
+        /**
+         * The ID of an existing account.
+         */
+        customer_account?: string;
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+        /**
+         * 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.
+         */
+        flow_data?: SessionCreateParams.FlowData;
+        /**
+         * The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer's `preferred_locales` or browser's locale is used.
+         */
+        locale?: SessionCreateParams.Locale;
+        /**
+         * The `on_behalf_of` account to use for this session. 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.
+         */
+        on_behalf_of?: string;
+        /**
+         * The default URL to redirect customers to when they click on the portal's link to return to your website.
+         */
+        return_url?: string;
+    }
+    namespace SessionCreateParams {
+        interface FlowData {
+            /**
+             * Behavior after the flow is completed.
+             */
+            after_completion?: FlowData.AfterCompletion;
+            /**
+             * Configuration when `flow_data.type=subscription_cancel`.
+             */
+            subscription_cancel?: FlowData.SubscriptionCancel;
+            /**
+             * Configuration when `flow_data.type=subscription_update`.
+             */
+            subscription_update?: FlowData.SubscriptionUpdate;
+            /**
+             * Configuration when `flow_data.type=subscription_update_confirm`.
+             */
+            subscription_update_confirm?: FlowData.SubscriptionUpdateConfirm;
+            /**
+             * Type of flow that the customer will go through.
+             */
+            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';
+        namespace FlowData {
+            interface AfterCompletion {
+                /**
+                 * Configuration when `after_completion.type=hosted_confirmation`.
+                 */
+                hosted_confirmation?: AfterCompletion.HostedConfirmation;
+                /**
+                 * Configuration when `after_completion.type=redirect`.
+                 */
+                redirect?: AfterCompletion.Redirect;
+                /**
+                 * The specified behavior after the flow is completed.
+                 */
+                type: AfterCompletion.Type;
+            }
+            interface SubscriptionCancel {
+                /**
+                 * Specify a retention strategy to be used in the cancellation flow.
+                 */
+                retention?: SubscriptionCancel.Retention;
+                /**
+                 * The ID of the subscription to be canceled.
+                 */
+                subscription: string;
+            }
+            interface SubscriptionUpdate {
+                /**
+                 * The ID of the subscription to be updated.
+                 */
+                subscription: string;
+            }
+            interface SubscriptionUpdateConfirm {
+                /**
+                 * The coupon or promotion code to apply to this subscription update.
+                 */
+                discounts?: Array<SubscriptionUpdateConfirm.Discount>;
+                /**
+                 * 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.
+                 */
+                items: Array<SubscriptionUpdateConfirm.Item>;
+                /**
+                 * The ID of the subscription to be updated.
+                 */
+                subscription: string;
+            }
+            type Type = 'payment_method_update' | 'subscription_cancel' | 'subscription_update' | 'subscription_update_confirm';
+            namespace AfterCompletion {
+                interface HostedConfirmation {
+                    /**
+                     * A custom message to display to the customer after the flow is completed.
+                     */
+                    custom_message?: string;
+                }
+                interface Redirect {
+                    /**
+                     * The URL the customer will be redirected to after the flow is completed.
+                     */
+                    return_url: string;
+                }
+                type Type = 'hosted_confirmation' | 'portal_homepage' | 'redirect';
+            }
+            namespace SubscriptionCancel {
+                interface Retention {
+                    /**
+                     * Configuration when `retention.type=coupon_offer`.
+                     */
+                    coupon_offer: Retention.CouponOffer;
+                    /**
+                     * Type of retention strategy to use with the customer.
+                     */
+                    type: 'coupon_offer';
+                }
+                namespace Retention {
+                    interface CouponOffer {
+                        /**
+                         * The ID of the coupon to be offered.
+                         */
+                        coupon: string;
+                    }
+                }
+            }
+            namespace SubscriptionUpdateConfirm {
+                interface Discount {
+                    /**
+                     * The ID of the coupon to apply to this subscription update.
+                     */
+                    coupon?: string;
+                    /**
+                     * The ID of a promotion code to apply to this subscription update.
+                     */
+                    promotion_code?: string;
+                }
+                interface Item {
+                    /**
+                     * The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+                     */
+                    id: string;
+                    /**
+                     * 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).
+                     */
+                    price?: string;
+                    /**
+                     * [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+                     */
+                    quantity?: number;
+                }
+            }
+        }
+    }
+}

package/esm/resources/BillingPortal/Sessions.js

@@ -1,9 +1,11 @@
 // File generated from our OpenAPI spec
 import { StripeResource } from '../../StripeResource.js';
-const stripeMethod = StripeResource.method;
-export const Sessions = StripeResource.extend({
-    create: stripeMethod({
-        method: 'POST',
-        fullPath: '/v1/billing_portal/sessions',
-    }),
-});
+export class SessionResource extends StripeResource {
+    /**
+     * Creates a session of the customer portal.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/billing_portal/sessions', params, options);
+    }
+}
+//# sourceMappingURL=Sessions.js.map

package/esm/resources/BillingPortal/Sessions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sessions.js","sourceRoot":"","sources":["../../../src/resources/BillingPortal/Sessions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAIvD,MAAM,OAAO,eAAgB,SAAQ,cAAc;IACjD;;OAEG;IACH,MAAM,CACJ,MAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,6BAA6B,EAC7B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}

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

@@ -0,0 +1,20 @@
+import { Stripe } from '../../stripe.core.js';
+import { BillingPortal as BillingPortalNamespace0, Configuration, ConfigurationResource } from './Configurations.js';
+import { BillingPortal as BillingPortalNamespace1, Session, SessionResource } from './Sessions.js';
+export { Configuration } from './Configurations.js';
+export { Session } from './Sessions.js';
+export declare class BillingPortal {
+    private readonly stripe;
+    configurations: ConfigurationResource;
+    sessions: SessionResource;
+    constructor(stripe: Stripe);
+}
+export declare namespace BillingPortal {
+    export type ConfigurationListParams = BillingPortalNamespace0.ConfigurationListParams;
+    export type ConfigurationCreateParams = BillingPortalNamespace0.ConfigurationCreateParams;
+    export type ConfigurationRetrieveParams = BillingPortalNamespace0.ConfigurationRetrieveParams;
+    export type ConfigurationUpdateParams = BillingPortalNamespace0.ConfigurationUpdateParams;
+    export { Configuration };
+    export type SessionCreateParams = BillingPortalNamespace1.SessionCreateParams;
+    export { Session };
+}

package/esm/resources/BillingPortal/index.js

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec
+import { ConfigurationResource, } from './Configurations.js';
+import { SessionResource, } from './Sessions.js';
+export class BillingPortal {
+    constructor(stripe) {
+        this.stripe = stripe;
+        this.configurations = new ConfigurationResource(stripe);
+        this.sessions = new SessionResource(stripe);
+    }
+}
+//# sourceMappingURL=index.js.map

package/esm/resources/BillingPortal/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/BillingPortal/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAGvC,OAAO,EAGL,qBAAqB,GACtB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAGL,eAAe,GAChB,MAAM,eAAe,CAAC;AAKvB,MAAM,OAAO,aAAa;IAIxB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,cAAc,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;CACF"}

package/esm/resources/Capabilities.d.ts

@@ -0,0 +1,160 @@
+import { Account } from './Accounts.js';
+export interface Capability {
+    /**
+     * The identifier for the capability.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'capability';
+    /**
+     * The account for which the capability enables functionality.
+     */
+    account: string | Account;
+    future_requirements?: Capability.FutureRequirements;
+    /**
+     * Whether the capability has been requested.
+     */
+    requested: boolean;
+    /**
+     * Time at which the capability was requested. Measured in seconds since the Unix epoch.
+     */
+    requested_at: number | null;
+    requirements?: Capability.Requirements;
+    /**
+     * The status of the capability.
+     */
+    status: Capability.Status;
+}
+export declare namespace Capability {
+    interface FutureRequirements {
+        /**
+         * 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.
+         */
+        alternatives: Array<FutureRequirements.Alternative> | null;
+        /**
+         * 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.
+         */
+        current_deadline: number | null;
+        /**
+         * 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.
+         */
+        currently_due: Array<string>;
+        /**
+         * 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.
+         */
+        disabled_reason: FutureRequirements.DisabledReason | null;
+        /**
+         * Details about validation and verification failures for `due` requirements that must be resolved.
+         */
+        errors: Array<FutureRequirements.Error>;
+        /**
+         * Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
+         */
+        eventually_due: Array<string>;
+        /**
+         * 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`.
+         */
+        past_due: Array<string>;
+        /**
+         * 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.
+         */
+        pending_verification: Array<string>;
+    }
+    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.
+         */
+        alternatives: Array<Requirements.Alternative> | null;
+        /**
+         * 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.
+         */
+        current_deadline: number | null;
+        /**
+         * 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.
+         */
+        currently_due: Array<string>;
+        /**
+         * Description of why the capability is disabled. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification).
+         */
+        disabled_reason: Requirements.DisabledReason | null;
+        /**
+         * Details about validation and verification failures for `due` requirements that must be resolved.
+         */
+        errors: Array<Requirements.Error>;
+        /**
+         * 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.
+         */
+        eventually_due: Array<string>;
+        /**
+         * Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the capability on the account.
+         */
+        past_due: Array<string>;
+        /**
+         * 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.
+         */
+        pending_verification: Array<string>;
+    }
+    type Status = 'active' | 'inactive' | 'pending' | 'unrequested';
+    namespace FutureRequirements {
+        interface Alternative {
+            /**
+             * Fields that can be provided to resolve all fields in `original_fields_due`.
+             */
+            alternative_fields_due: Array<string>;
+            /**
+             * Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
+             */
+            original_fields_due: Array<string>;
+        }
+        type DisabledReason = 'other' | 'paused.inactivity' | 'pending.onboarding' | 'pending.review' | 'platform_disabled' | 'platform_paused' | 'rejected.inactivity' | 'rejected.other' | 'rejected.unsupported_business' | 'requirements.fields_needed';
+        interface Error {
+            /**
+             * The code for the type of error.
+             */
+            code: Error.Code;
+            /**
+             * An informative message that indicates the error type and provides additional details about the error.
+             */
+            reason: string;
+            /**
+             * The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+             */
+            requirement: string;
+        }
+        namespace Error {
+            type Code = 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | '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';
+        }
+    }
+    namespace Requirements {
+        interface Alternative {
+            /**
+             * Fields that can be provided to resolve all fields in `original_fields_due`.
+             */
+            alternative_fields_due: Array<string>;
+            /**
+             * Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
+             */
+            original_fields_due: Array<string>;
+        }
+        type DisabledReason = 'other' | 'paused.inactivity' | 'pending.onboarding' | 'pending.review' | 'platform_disabled' | 'platform_paused' | 'rejected.inactivity' | 'rejected.other' | 'rejected.unsupported_business' | 'requirements.fields_needed';
+        interface Error {
+            /**
+             * The code for the type of error.
+             */
+            code: Error.Code;
+            /**
+             * An informative message that indicates the error type and provides additional details about the error.
+             */
+            reason: string;
+            /**
+             * The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+             */
+            requirement: string;
+        }
+        namespace Error {
+            type Code = 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | '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';
+        }
+    }
+}