stripe 20.1.0-beta.1 → 20.1.1

package/types/Treasury/Transactions.d.ts

@@ -4,7 +4,7 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Treasury {
       /**
-       * Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance.
+       * Transactions represent changes to a [FinancialAccount's](https://api.stripe.com#financial_accounts) balance.
        */
       interface Transaction {
         /**
@@ -100,33 +100,33 @@ declare module 'stripe' {
 
         interface FlowDetails {
           /**
-           * You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
+           * You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
            */
           credit_reversal?: Stripe.Treasury.CreditReversal;
 
           /**
-           * You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
+           * You can reverse some [ReceivedDebits](https://api.stripe.com#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
            */
           debit_reversal?: Stripe.Treasury.DebitReversal;
 
           /**
-           * Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
+           * Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://api.stripe.com#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
            *
            * Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)
            */
           inbound_transfer?: Stripe.Treasury.InboundTransfer;
 
           /**
-           * When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`
-           * object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the
+           * When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization`
+           * object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the
            * purchase to be completed successfully.
            *
-           * Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)
+           * Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations)
            */
           issuing_authorization?: Stripe.Issuing.Authorization;
 
           /**
-           * Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
+           * Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers).
            *
            * Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
            *
@@ -135,7 +135,7 @@ declare module 'stripe' {
           outbound_payment?: Stripe.Treasury.OutboundPayment;
 
           /**
-           * Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
+           * Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
            *
            * Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
            *
@@ -144,12 +144,12 @@ declare module 'stripe' {
           outbound_transfer?: Stripe.Treasury.OutboundTransfer;
 
           /**
-           * ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
+           * ReceivedCredits represent funds sent to a [FinancialAccount](https://api.stripe.com#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
            */
           received_credit?: Stripe.Treasury.ReceivedCredit;
 
           /**
-           * ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.
+           * ReceivedDebits represent funds pulled from a [FinancialAccount](https://api.stripe.com#financial_accounts). These are not initiated from the FinancialAccount.
            */
           received_debit?: Stripe.Treasury.ReceivedDebit;
 

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

@@ -5,7 +5,7 @@ declare module 'stripe' {
     namespace V2 {
       namespace Core {
         /**
-         * AccountLinks are the means by which a Merchant grants an Account permission to access Stripe-hosted applications, such as Recipient Onboarding. This API is only available for users enrolled in the public preview for Accounts v2.
+         * Account Links let a platform create a temporary, single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information.
          */
         interface AccountLink {
           /**
@@ -14,17 +14,17 @@ declare module 'stripe' {
           object: 'v2.core.account_link';
 
           /**
-           * The ID of the Account the link was created for.
+           * The ID of the connected account this Account Link applies to.
            */
           account: string;
 
           /**
-           * The timestamp at which this AccountLink was created.
+           * The timestamp at which this Account Link was created.
            */
           created: string;
 
           /**
-           * The timestamp at which this AccountLink will expire.
+           * The timestamp at which this Account Link will expire.
            */
           expires_at: string;
 
@@ -34,12 +34,12 @@ declare module 'stripe' {
           livemode: boolean;
 
           /**
-           * The URL for the AccountLink.
+           * The URL at which the account can access the Stripe-hosted flow.
            */
           url: string;
 
           /**
-           * The use case of AccountLink the user is requesting.
+           * Hash containing usage options.
            */
           use_case: AccountLink.UseCase;
         }
@@ -47,17 +47,17 @@ declare module 'stripe' {
         namespace AccountLink {
           interface UseCase {
             /**
-             * Open Enum. The type of AccountLink the user is requesting.
+             * Open Enum. The type of Account Link the user is requesting.
              */
             type: UseCase.Type;
 
             /**
-             * Indicates that the AccountLink provided should onboard an account.
+             * Hash containing configuration options for an Account Link object that onboards a new account.
              */
             account_onboarding?: UseCase.AccountOnboarding;
 
             /**
-             * Indicates that the AccountLink provided should update a previously onboarded account.
+             * Hash containing configuration options for an Account Link that updates an existing account.
              */
             account_update?: UseCase.AccountUpdate;
           }
@@ -104,11 +104,7 @@ declare module 'stripe' {
                 type FutureRequirements = 'include' | 'omit';
               }
 
-              type Configuration =
-                | 'customer'
-                | 'merchant'
-                | 'recipient'
-                | 'storer';
+              type Configuration = 'customer' | 'merchant' | 'recipient';
             }
 
             interface AccountUpdate {
@@ -123,7 +119,7 @@ declare module 'stripe' {
               configurations: Array<AccountUpdate.Configuration>;
 
               /**
-               * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
+               * The URL the user will be redirected to if the Account Link is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new Account Link with the same parameters used to create the original Account Link, then redirect the user to the new Account Link URL so they can continue the flow. Make sure to authenticate the user before redirecting to the new Account Link, in case the URL leaks to a third party. If a new Account Link can't be generated, or if the redirect fails, you should display a useful error to the user.
                */
               refresh_url: string;
 
@@ -136,7 +132,7 @@ declare module 'stripe' {
             namespace AccountUpdate {
               interface CollectionOptions {
                 /**
-                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
+                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). The default value is `currently_due`.
                  */
                 fields?: CollectionOptions.Fields;
 
@@ -152,11 +148,7 @@ declare module 'stripe' {
                 type FutureRequirements = 'include' | 'omit';
               }
 
-              type Configuration =
-                | 'customer'
-                | 'merchant'
-                | 'recipient'
-                | 'storer';
+              type Configuration = 'customer' | 'merchant' | 'recipient';
             }
 
             type Type = 'account_onboarding' | 'account_update';

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

@@ -19,17 +19,17 @@ declare module 'stripe' {
         namespace AccountLinkCreateParams {
           interface UseCase {
             /**
-             * Open Enum. The type of AccountLink the user is requesting.
+             * Open Enum. The type of Account Link the user is requesting.
              */
             type: UseCase.Type;
 
             /**
-             * Indicates that the AccountLink provided should onboard an account.
+             * Hash containing configuration options for an Account Link object that onboards a new account.
              */
             account_onboarding?: UseCase.AccountOnboarding;
 
             /**
-             * Indicates that the AccountLink provided should update a previously onboarded account.
+             * Hash containing configuration options for an Account Link that updates an existing account.
              */
             account_update?: UseCase.AccountUpdate;
           }
@@ -76,11 +76,7 @@ declare module 'stripe' {
                 type FutureRequirements = 'include' | 'omit';
               }
 
-              type Configuration =
-                | 'customer'
-                | 'merchant'
-                | 'recipient'
-                | 'storer';
+              type Configuration = 'customer' | 'merchant' | 'recipient';
             }
 
             interface AccountUpdate {
@@ -95,7 +91,7 @@ declare module 'stripe' {
               configurations: Array<AccountUpdate.Configuration>;
 
               /**
-               * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
+               * The URL the user will be redirected to if the Account Link is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new Account Link with the same parameters used to create the original Account Link, then redirect the user to the new Account Link URL so they can continue the flow. Make sure to authenticate the user before redirecting to the new Account Link, in case the URL leaks to a third party. If a new Account Link can't be generated, or if the redirect fails, you should display a useful error to the user.
                */
               refresh_url: string;
 
@@ -108,7 +104,7 @@ declare module 'stripe' {
             namespace AccountUpdate {
               interface CollectionOptions {
                 /**
-                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
+                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). The default value is `currently_due`.
                  */
                 fields?: CollectionOptions.Fields;
 
@@ -124,11 +120,7 @@ declare module 'stripe' {
                 type FutureRequirements = 'include' | 'omit';
               }
 
-              type Configuration =
-                | 'customer'
-                | 'merchant'
-                | 'recipient'
-                | 'storer';
+              type Configuration = 'customer' | 'merchant' | 'recipient';
             }
 
             type Type = 'account_onboarding' | 'account_update';
@@ -139,7 +131,7 @@ declare module 'stripe' {
       namespace Core {
         class AccountLinksResource {
           /**
-           * Creates an AccountLink object that includes a single-use Stripe URL that the merchant can redirect their user to in order to take them to a Stripe-hosted application such as Recipient Onboarding.
+           * Creates an AccountLink object that includes a single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information.
            */
           create(
             params: AccountLinkCreateParams,

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

@@ -5,7 +5,7 @@ declare module 'stripe' {
     namespace V2 {
       namespace Core {
         /**
-         * Person retrieval response schema.
+         * A Person represents an individual associated with an Account's identity (for example, an owner, director, executive, or representative). Use Persons to provide and update identity information for verification and compliance.
          */
         interface AccountPerson {
           /**
@@ -167,7 +167,7 @@ declare module 'stripe' {
             state?: string;
 
             /**
-             * Town or cho-me.
+             * Town or district.
              */
             town?: string;
           }
@@ -256,7 +256,7 @@ declare module 'stripe' {
             state?: string;
 
             /**
-             * Town or cho-me.
+             * Town or district.
              */
             town?: string;
           }
@@ -406,36 +406,81 @@ declare module 'stripe' {
             type Type =
               | 'ae_eid'
               | 'ao_nif'
+              | 'ar_cuil'
               | 'ar_dni'
+              | 'at_stn'
               | 'az_tin'
               | 'bd_brc'
               | 'bd_etin'
               | 'bd_nid'
+              | 'be_nrn'
+              | 'bg_ucn'
+              | 'bn_nric'
               | 'br_cpf'
+              | 'ca_sin'
+              | 'ch_oasi'
+              | 'cl_rut'
+              | 'cn_pp'
+              | 'co_nuip'
+              | 'cr_ci'
               | 'cr_cpf'
               | 'cr_dimex'
               | 'cr_nite'
+              | 'cy_tic'
+              | 'cz_rc'
               | 'de_stn'
+              | 'dk_cpr'
+              | 'do_cie'
               | 'do_rcn'
+              | 'ec_ci'
+              | 'ee_ik'
+              | 'es_nif'
+              | 'fi_hetu'
+              | 'fr_nir'
+              | 'gb_nino'
+              | 'gr_afm'
               | 'gt_nit'
               | 'hk_id'
+              | 'hr_oib'
+              | 'hu_ad'
+              | 'id_nik'
+              | 'ie_ppsn'
+              | 'is_kt'
+              | 'it_cf'
+              | 'jp_inc'
+              | 'ke_pin'
               | 'kz_iin'
+              | 'li_peid'
+              | 'lt_ak'
+              | 'lu_nif'
+              | 'lv_pk'
               | 'mx_rfc'
               | 'my_nric'
               | 'mz_nuit'
+              | 'ng_nin'
               | 'nl_bsn'
+              | 'no_nin'
+              | 'nz_ird'
               | 'pe_dni'
               | 'pk_cnic'
               | 'pk_snic'
+              | 'pl_pesel'
+              | 'pt_nif'
+              | 'ro_cnp'
               | 'sa_tin'
+              | 'se_pin'
               | 'sg_fin'
               | 'sg_nric'
+              | 'sk_dic'
               | 'th_lc'
               | 'th_pin'
+              | 'tr_tin'
               | 'us_itin'
               | 'us_itin_last_4'
               | 'us_ssn'
-              | 'us_ssn_last_4';
+              | 'us_ssn_last_4'
+              | 'uy_dni'
+              | 'za_id';
           }
 
           type LegalGender = 'female' | 'male';
@@ -444,12 +489,12 @@ declare module 'stripe' {
 
           interface Relationship {
             /**
-             * Whether the individual is an authorizer of the Account's legal entity.
+             * Whether the individual is an authorizer of the Account's identity.
              */
             authorizer?: boolean;
 
             /**
-             * Whether the individual is a director of the Account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
+             * Whether the individual is a director of the Account's identity. Directors are typically members of the governing board of the company or are responsible for making sure that the company meets its regulatory obligations.
              */
             director?: boolean;
 
@@ -464,12 +509,12 @@ declare module 'stripe' {
             legal_guardian?: boolean;
 
             /**
-             * Whether the individual is an owner of the Account's legal entity.
+             * Whether the individual is an owner of the Account's identity.
              */
             owner?: boolean;
 
             /**
-             * The percent owned by the individual of the Account's legal entity.
+             * The percentage of the Account's identity that the individual owns.
              */
             percent_ownership?: string;
 
@@ -529,7 +574,7 @@ declare module 'stripe' {
               state?: string;
 
               /**
-               * Town or cho-me.
+               * Town or district.
                */
               town?: string;
             }
@@ -566,7 +611,7 @@ declare module 'stripe' {
               state?: string;
 
               /**
-               * Town or cho-me.
+               * Town or district.
                */
               town?: string;
             }