stripe 19.2.0-alpha.2 → 19.2.0-alpha.4

package/types/Identity/BlocklistEntriesResource.d.ts

@@ -0,0 +1,146 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Identity {
+      interface BlocklistEntryCreateParams {
+        /**
+         * The type of blocklist entry to be created.
+         */
+        entry_type: BlocklistEntryCreateParams.EntryType;
+
+        /**
+         * The identifier of the VerificationReport to create the BlocklistEntry from.
+         */
+        verification_report: string;
+
+        /**
+         * When true, the created BlocklistEntry will be used to retroactively unverify matching verifications.
+         */
+        check_existing_verifications?: boolean;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace BlocklistEntryCreateParams {
+        type EntryType = 'document' | 'selfie';
+      }
+
+      interface BlocklistEntryRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface BlocklistEntryListParams extends PaginationParams {
+        /**
+         * Only return BlocklistEntries that were created during the given date interval.
+         */
+        created?: Stripe.RangeQueryParam | number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Only return blocklist entries with the specified status.
+         */
+        status?: BlocklistEntryListParams.Status;
+
+        /**
+         * Only return blocklist entries of the specified type.
+         */
+        type?: BlocklistEntryListParams.Type;
+
+        /**
+         * Only return blocklist entries created from this verification report.
+         */
+        verification_report?: string;
+      }
+
+      namespace BlocklistEntryListParams {
+        type Status = 'active' | 'disabled' | 'redacted';
+
+        type Type = 'document' | 'selfie';
+      }
+
+      interface BlocklistEntryDisableParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class BlocklistEntriesResource {
+        /**
+         * Creates a BlocklistEntry object from a verification report.
+         *
+         * A blocklist entry prevents future identity verifications that match the same identity information.
+         * You can create blocklist entries from verification reports that contain document extracted data
+         * or a selfie.
+         *
+         * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#add-a-blocklist-entry)
+         */
+        create(
+          params: BlocklistEntryCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.BlocklistEntry>>;
+
+        /**
+         * Retrieves a BlocklistEntry object by its identifier.
+         *
+         * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+         */
+        retrieve(
+          id: string,
+          params?: BlocklistEntryRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.BlocklistEntry>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.BlocklistEntry>>;
+
+        /**
+         * Returns a list of BlocklistEntry objects associated with your account.
+         *
+         * The blocklist entries are returned sorted by creation date, with the most recently created
+         * entries appearing first.
+         *
+         * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+         */
+        list(
+          params?: BlocklistEntryListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Identity.BlocklistEntry>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Identity.BlocklistEntry>;
+
+        /**
+         * Disables a BlocklistEntry object.
+         *
+         * After a BlocklistEntry is disabled, it will no longer block future verifications that match
+         * the same information. This action is irreversible. To re-enable it, a new BlocklistEntry
+         * must be created using the same verification report.
+         *
+         * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#disable-a-blocklist-entry)
+         */
+        disable(
+          id: string,
+          params?: BlocklistEntryDisableParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.BlocklistEntry>>;
+        disable(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.BlocklistEntry>>;
+      }
+    }
+  }
+}

package/types/Identity/VerificationReports.d.ts

@@ -161,6 +161,11 @@ declare module 'stripe' {
            * Sex as it appears in the document.
            */
           unparsed_sex?: string | null;
+
+          /**
+           * If document was not verified due to extracted data being on the blocklist, this is the token of the BlocklistEntry that blocked it
+           */
+          blocked_by_entry?: string | Stripe.Identity.BlocklistEntry | null;
         }
 
         namespace Document {
@@ -454,6 +459,11 @@ declare module 'stripe' {
            * Status of this `selfie` check.
            */
           status: Selfie.Status;
+
+          /**
+           * If selfie was not verified due to being on the blocklist, this is the token of the BlocklistEntry that blocked it
+           */
+          blocked_by_entry?: string | Stripe.Identity.BlocklistEntry | null;
         }
 
         namespace Selfie {

package/types/Identity/VerificationReportsResource.d.ts

@@ -11,6 +11,11 @@ declare module 'stripe' {
       }
 
       interface VerificationReportListParams extends PaginationParams {
+        /**
+         * Only return VerificationReports that were blocked by this BlocklistEntry id.
+         */
+        blocked_by_entry?: string;
+
         /**
          * A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
          */

package/types/V2/Billing/Cadences.d.ts

@@ -470,7 +470,7 @@ declare module 'stripe' {
 
               interface EmailDelivery {
                 /**
-                 * Controls emails for when the payment is due. For example after the invoice is finilized and transition to Open state.
+                 * Controls emails for when the payment is due. For example after the invoice is finalized and transitions to Open state.
                  */
                 payment_due?: EmailDelivery.PaymentDue;
               }
@@ -483,7 +483,7 @@ declare module 'stripe' {
                   enabled: boolean;
 
                   /**
-                   * If true the payment link to hosted invocie page would be included in email and PDF of the invoice.
+                   * If true the payment link to hosted invoice page would be included in email and PDF of the invoice.
                    */
                   include_payment_link: boolean;
                 }

package/types/V2/Billing/CollectionSettingVersions.d.ts

@@ -57,7 +57,7 @@ declare module 'stripe' {
 
           interface EmailDelivery {
             /**
-             * Controls emails for when the payment is due. For example after the invoice is finilized and transition to Open state.
+             * Controls emails for when the payment is due. For example after the invoice is finalized and transitions to Open state.
              */
             payment_due?: EmailDelivery.PaymentDue;
           }
@@ -70,7 +70,7 @@ declare module 'stripe' {
               enabled: boolean;
 
               /**
-               * If true the payment link to hosted invocie page would be included in email and PDF of the invoice.
+               * If true the payment link to hosted invoice page would be included in email and PDF of the invoice.
                */
               include_payment_link: boolean;
             }

package/types/V2/Billing/CollectionSettings.d.ts

@@ -80,7 +80,7 @@ declare module 'stripe' {
 
           interface EmailDelivery {
             /**
-             * Controls emails for when the payment is due. For example after the invoice is finilized and transition to Open state.
+             * Controls emails for when the payment is due. For example after the invoice is finalized and transitions to Open state.
              */
             payment_due?: EmailDelivery.PaymentDue;
           }
@@ -93,7 +93,7 @@ declare module 'stripe' {
               enabled: boolean;
 
               /**
-               * If true the payment link to hosted invocie page would be included in email and PDF of the invoice.
+               * If true the payment link to hosted invoice page would be included in email and PDF of the invoice.
                */
               include_payment_link: boolean;
             }

package/types/V2/Billing/CollectionSettingsResource.d.ts

@@ -46,7 +46,7 @@ declare module 'stripe' {
 
           interface EmailDelivery {
             /**
-             * Controls emails for when the payment is due. For example after the invoice is finilized and transition to Open state.
+             * Controls emails for when the payment is due. For example after the invoice is finalized and transitions to Open state.
              */
             payment_due?: EmailDelivery.PaymentDue;
           }
@@ -59,7 +59,7 @@ declare module 'stripe' {
               enabled: boolean;
 
               /**
-               * If true the payment link to hosted invocie page would be included in email and PDF of the invoice.
+               * If true the payment link to hosted invoice page would be included in email and PDF of the invoice.
                */
               include_payment_link: boolean;
             }
@@ -353,7 +353,7 @@ declare module 'stripe' {
 
           interface EmailDelivery {
             /**
-             * Controls emails for when the payment is due. For example after the invoice is finilized and transition to Open state.
+             * Controls emails for when the payment is due. For example after the invoice is finalized and transitions to Open state.
              */
             payment_due?: EmailDelivery.PaymentDue;
           }
@@ -366,7 +366,7 @@ declare module 'stripe' {
               enabled: boolean;
 
               /**
-               * If true the payment link to hosted invocie page would be included in email and PDF of the invoice.
+               * If true the payment link to hosted invoice page would be included in email and PDF of the invoice.
                */
               include_payment_link: boolean;
             }

package/types/V2/Billing/PricingPlanSubscriptionComponents.d.ts

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * A set of component subscriptions for a Pricing Plan Subscription.
+         */
+        interface PricingPlanSubscriptionComponents {
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.billing.pricing_plan_subscription_components';
+
+          /**
+           * The component subscriptions of the Pricing Plan Subscription.
+           */
+          components: Array<PricingPlanSubscriptionComponents.Component>;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+        }
+
+        namespace PricingPlanSubscriptionComponents {
+          interface Component {
+            /**
+             * The Pricing Plan Component associated with this component subscription.
+             */
+            pricing_plan_component: string;
+
+            /**
+             * The type of subscription.
+             */
+            type: Component.Type;
+
+            /**
+             * The ID of the License Fee Subscription.
+             */
+            license_fee_subscription?: string;
+
+            /**
+             * The ID of the Rate Card Subscription.
+             */
+            rate_card_subscription?: string;
+          }
+
+          namespace Component {
+            type Type = 'license_fee_subscription' | 'rate_card_subscription';
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/PricingPlanSubscriptions/ComponentsResource.d.ts

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        namespace PricingPlanSubscriptions {
+          interface ComponentRetrieveParams {}
+        }
+      }
+
+      namespace Billing {
+        namespace PricingPlanSubscriptions {
+          class ComponentsResource {
+            /**
+             * Retrieve a Pricing Plan Subscription's components.
+             */
+            retrieve(
+              id: string,
+              params?: ComponentRetrieveParams,
+              options?: RequestOptions
+            ): Promise<
+              Stripe.Response<
+                Stripe.V2.Billing.PricingPlanSubscriptionComponents
+              >
+            >;
+            retrieve(
+              id: string,
+              options?: RequestOptions
+            ): Promise<
+              Stripe.Response<
+                Stripe.V2.Billing.PricingPlanSubscriptionComponents
+              >
+            >;
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts

@@ -73,6 +73,8 @@ declare module 'stripe' {
 
       namespace Billing {
         class PricingPlanSubscriptionsResource {
+          components: Stripe.V2.Billing.PricingPlanSubscriptions.ComponentsResource;
+
           /**
            * Retrieve a Pricing Plan Subscription object.
            */

package/types/V2/Core/Accounts.d.ts

@@ -23,6 +23,11 @@ declare module 'stripe' {
            */
           applied_configurations: Array<Account.AppliedConfiguration>;
 
+          /**
+           * A value indicating if the Account has been closed.
+           */
+          closed?: boolean;
+
           /**
            * An Account Configuration which allows the Account to take on a key persona across Stripe products.
            */
@@ -585,6 +590,7 @@ declare module 'stripe' {
                 type LocationSource =
                   | 'identity_address'
                   | 'ip_address'
+                  | 'payment_method'
                   | 'shipping_address';
               }
 
@@ -4156,6 +4162,11 @@ declare module 'stripe' {
                    * Can hold storage-type funds on Stripe in GBP.
                    */
                   gbp?: HoldsCurrencies.Gbp;
+
+                  /**
+                   * Can hold storage-type funds on Stripe in USD.
+                   */
+                  usd?: HoldsCurrencies.Usd;
                 }
 
                 namespace HoldsCurrencies {
@@ -4211,6 +4222,59 @@ declare module 'stripe' {
                         | 'provide_info';
                     }
                   }
+
+                  interface Usd {
+                    /**
+                     * Whether the Capability has been requested.
+                     */
+                    requested: boolean;
+
+                    /**
+                     * The status of the Capability.
+                     */
+                    status: Usd.Status;
+
+                    /**
+                     * Additional details regarding the status of the Capability. `status_details` will be empty if the Capability's status is `active`.
+                     */
+                    status_details: Array<Usd.StatusDetail>;
+                  }
+
+                  namespace Usd {
+                    type Status =
+                      | 'active'
+                      | 'pending'
+                      | 'restricted'
+                      | 'unsupported';
+
+                    interface StatusDetail {
+                      /**
+                       * Machine-readable code explaining the reason for the Capability to be in its current status.
+                       */
+                      code: StatusDetail.Code;
+
+                      /**
+                       * Machine-readable code explaining how to make the Capability active.
+                       */
+                      resolution: StatusDetail.Resolution;
+                    }
+
+                    namespace StatusDetail {
+                      type Code =
+                        | 'determining_status'
+                        | 'requirements_past_due'
+                        | 'requirements_pending_verification'
+                        | 'restricted_other'
+                        | 'unsupported_business'
+                        | 'unsupported_country'
+                        | 'unsupported_entity_type';
+
+                      type Resolution =
+                        | 'contact_stripe'
+                        | 'no_resolution'
+                        | 'provide_info';
+                    }
+                  }
                 }
 
                 interface InboundTransfers {
@@ -4717,7 +4781,11 @@ declare module 'stripe' {
             }
 
             namespace Responsibilities {
-              type FeesCollector = 'application' | 'stripe';
+              type FeesCollector =
+                | 'application'
+                | 'application_custom'
+                | 'application_express'
+                | 'stripe';
 
               type LossesCollector = 'application' | 'stripe';
             }
@@ -4725,7 +4793,7 @@ declare module 'stripe' {
 
           interface Identity {
             /**
-             * Attestations from the identity's key people, e.g. owners, executives, directors.
+             * Attestations from the identity's key people, e.g. owners, executives, directors, representatives.
              */
             attestations?: Identity.Attestations;
 
@@ -4767,6 +4835,11 @@ declare module 'stripe' {
                */
               persons_provided?: Attestations.PersonsProvided;
 
+              /**
+               * This hash is used to attest that the representative is authorized to act as the representative of their legal entity.
+               */
+              representative_declaration?: Attestations.RepresentativeDeclaration;
+
               /**
                * Attestations of accepted terms of service agreements.
                */
@@ -4836,6 +4909,23 @@ declare module 'stripe' {
                   | 'qualifies_as_financial_institution';
               }
 
+              interface RepresentativeDeclaration {
+                /**
+                 * The time marking when the representative attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+                 */
+                date?: string;
+
+                /**
+                 * The IP address from which the representative attestation was made.
+                 */
+                ip?: string;
+
+                /**
+                 * The user agent of the browser from which the representative attestation was made.
+                 */
+                user_agent?: string;
+              }
+
               interface TermsOfService {
                 /**
                  * Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance).
@@ -6679,6 +6769,7 @@ declare module 'stripe' {
                     | 'gb_bank_transfer_payments'
                     | 'grabpay_payments'
                     | 'holds_currencies.gbp'
+                    | 'holds_currencies.usd'
                     | 'ideal_payments'
                     | 'inbound_transfers.financial_accounts'
                     | 'jcb_payments'