diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index e0b2735086..52d771c1e6 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v972 \ No newline at end of file +v993 \ No newline at end of file diff --git a/types/Accounts.d.ts b/types/Accounts.d.ts index ec4a52c2dc..5419f1faa9 100644 --- a/types/Accounts.d.ts +++ b/types/Accounts.d.ts @@ -7,9 +7,14 @@ declare module 'stripe' { * properties on the account like its current requirements or if the account is * enabled to make live charges or receive payouts. * - * For Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that - * account has started to go through Connect Onboarding. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), - * some properties are only returned for Custom accounts. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts). + * For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + * is `application`, which includes Custom accounts, the properties below are always + * returned. + * + * For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + * is `stripe`, which includes Standard and Express accounts, some properties are only returned + * until you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions) + * to start Connect Onboarding. Learn about the [differences between accounts](https://stripe.com/connect/accounts). */ interface Account { /** @@ -28,7 +33,7 @@ declare module 'stripe' { business_profile?: Account.BusinessProfile | null; /** - * The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property is only returned for Custom accounts. + * The business type. After you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ business_type?: Account.BusinessType | null; @@ -64,7 +69,7 @@ declare module 'stripe' { deleted?: void; /** - * Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. + * Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. */ details_submitted: boolean; @@ -83,10 +88,9 @@ declare module 'stripe' { /** * This is an object representing a person associated with a Stripe account. * - * A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. - * See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps. + * A platform cannot access a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. * - * Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/handling-api-verification#person-information) + * See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information). */ individual?: Stripe.Person; @@ -110,7 +114,7 @@ declare module 'stripe' { tos_acceptance?: Account.TosAcceptance; /** - * The Stripe account type. Can be `standard`, `express`, or `custom`. + * The Stripe account type. Can be `standard`, `express`, `custom`, or `none`. */ type: Account.Type; } @@ -752,7 +756,7 @@ declare module 'stripe' { namespace Controller { interface Fees { /** - * A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. + * A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior). */ payer: Fees.Payer; } @@ -1283,7 +1287,7 @@ declare module 'stripe' { interface Payouts { /** - * A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `false` for Custom accounts, otherwise `true`. + * A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](https://stripe.com/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`. */ debit_negative_balances: boolean; diff --git a/types/AccountsResource.d.ts b/types/AccountsResource.d.ts index 6e9f453090..6c8bbd29db 100644 --- a/types/AccountsResource.d.ts +++ b/types/AccountsResource.d.ts @@ -14,17 +14,24 @@ declare module 'stripe' { business_profile?: AccountCreateParams.BusinessProfile; /** - * The business type. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. + * The business type. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ business_type?: AccountCreateParams.BusinessType; /** - * Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. + * Each key of the dictionary represents a capability, and each capability + * maps to its settings (for example, whether it has been requested or not). Each + * capability is inactive until you have provided its specific + * requirements and Stripe has verified them. An account might have some + * of its requested capabilities be active and some be inactive. + * + * Required when [account.controller.stripe_dashboard.type](https://stripe.com/api/accounts/create#create_account-controller-dashboard-type) + * is `none`, which includes Custom accounts. */ capabilities?: AccountCreateParams.Capabilities; /** - * Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. + * Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ company?: AccountCreateParams.Company; @@ -49,7 +56,7 @@ declare module 'stripe' { documents?: AccountCreateParams.Documents; /** - * The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. + * The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent. */ email?: string; @@ -59,14 +66,14 @@ declare module 'stripe' { expand?: Array; /** - * A card or bank account to attach to the account for receiving [payouts](https://docs.stripe.com/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://docs.stripe.com/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://docs.stripe.com/api#account_create_bank_account) creation. + * A card or bank account to attach to the account for receiving [payouts](https://stripe.com/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/api#account_create_bank_account) creation. * - * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://docs.stripe.com/api#account_create_bank_account) or [card creation](https://docs.stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. + * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/api#account_create_bank_account) or [card creation](https://stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ external_account?: string | AccountCreateParams.ExternalAccount; /** - * Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. + * Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ individual?: AccountCreateParams.Individual; @@ -81,7 +88,7 @@ declare module 'stripe' { settings?: AccountCreateParams.Settings; /** - * Details on the account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts. + * Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ tos_acceptance?: AccountCreateParams.TosAcceptance; @@ -857,7 +864,7 @@ declare module 'stripe' { namespace Controller { interface Fees { /** - * A value indicating the responsible payer of Stripe fees on this account. Defaults to `account`. + * A value indicating the responsible payer of Stripe fees on this account. Defaults to `account`. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior). */ payer?: Fees.Payer; } @@ -1490,17 +1497,24 @@ declare module 'stripe' { business_profile?: AccountUpdateParams.BusinessProfile; /** - * The business type. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. + * The business type. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ business_type?: AccountUpdateParams.BusinessType; /** - * Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. + * Each key of the dictionary represents a capability, and each capability + * maps to its settings (for example, whether it has been requested or not). Each + * capability is inactive until you have provided its specific + * requirements and Stripe has verified them. An account might have some + * of its requested capabilities be active and some be inactive. + * + * Required when [account.controller.stripe_dashboard.type](https://stripe.com/api/accounts/create#create_account-controller-dashboard-type) + * is `none`, which includes Custom accounts. */ capabilities?: AccountUpdateParams.Capabilities; /** - * Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. + * Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ company?: AccountUpdateParams.Company; @@ -1515,7 +1529,7 @@ declare module 'stripe' { documents?: AccountUpdateParams.Documents; /** - * The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. + * The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent. */ email?: string; @@ -1525,9 +1539,9 @@ declare module 'stripe' { expand?: Array; /** - * A card or bank account to attach to the account for receiving [payouts](https://docs.stripe.com/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://docs.stripe.com/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://docs.stripe.com/api#account_create_bank_account) creation. + * A card or bank account to attach to the account for receiving [payouts](https://stripe.com/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/api#account_create_bank_account) creation. * - * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://docs.stripe.com/api#account_create_bank_account) or [card creation](https://docs.stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. + * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/api#account_create_bank_account) or [card creation](https://stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ external_account?: Stripe.Emptyable< | string @@ -1537,7 +1551,7 @@ declare module 'stripe' { >; /** - * Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. + * Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ individual?: AccountUpdateParams.Individual; @@ -1552,7 +1566,7 @@ declare module 'stripe' { settings?: AccountUpdateParams.Settings; /** - * Details on the account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts. + * Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ tos_acceptance?: AccountUpdateParams.TosAcceptance; } @@ -3934,12 +3948,16 @@ declare module 'stripe' { ): Promise>; /** - * Updates a [connected account](https://stripe.com/docs/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are + * Updates a [connected account](https://stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are * left unchanged. * - * For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that - * account has started to go through Connect Onboarding. Once you create an [Account Link or Account Session](https://stripe.com/docs/api/account_links), - * some properties can only be changed or updated for Custom accounts. + * For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + * is application, which includes Custom accounts, you can update any information on the account. + * + * For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + * is stripe, which includes Standard and Express accounts, you can update all information until you create + * an [Account Link or Account Session](https://stripe.com/api/account_links) to start Connect onboarding, + * after which some properties can no longer be updated. * * To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our * [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts. @@ -3960,9 +3978,11 @@ declare module 'stripe' { list(options?: RequestOptions): ApiListPromise; /** - * With [Connect](https://stripe.com/docs/connect), you can delete accounts you manage. + * With [Connect](https://stripe.com/connect), you can delete accounts you manage. * - * Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero. + * Test-mode accounts can be deleted at any time. + * + * Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balanace_object) are zero. * * If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead. */ @@ -3986,9 +4006,9 @@ declare module 'stripe' { ): Promise>; /** - * Creates a single-use login link for an Express account to access their Stripe dashboard. + * Creates a single-use login link for a connected account to access the Express Dashboard. * - * You may only create login links for [Express accounts](https://stripe.com/docs/connect/express-accounts) connected to your platform. + * You can only create login links for accounts that use the [Express Dashboard](https://stripe.com/connect/express-dashboard) and are connected to your platform. */ createLoginLink( id: string, @@ -4083,9 +4103,9 @@ declare module 'stripe' { ): ApiListPromise; /** - * With [Connect](https://stripe.com/docs/connect), you may flag accounts as suspicious. + * With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged as suspicious. * - * Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero. + * Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero. */ reject( id: string, @@ -4165,9 +4185,14 @@ declare module 'stripe' { ): Promise>; /** - * Updates the metadata, account holder name, account holder type of a bank account belonging to a [Custom account](https://stripe.com/docs/connect/custom-accounts), and optionally sets it as the default for its currency. Other bank account details are not editable by design. + * Updates the metadata, account holder name, account holder type of a bank account belonging to + * a connected account and optionally sets it as the default for its currency. Other bank account + * details are not editable by design. + * + * You can only update bank accounts when [account.controller.requirement_collection is application, which includes Custom accounts](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection). * - * You can re-enable a disabled bank account by performing an update call without providing any arguments or changes. + * You can re-enable a disabled bank account by performing an update call without providing any + * arguments or changes. */ updateExternalAccount( accountId: string, diff --git a/types/Balance.d.ts b/types/Balance.d.ts index cc554f24f2..8487acc816 100644 --- a/types/Balance.d.ts +++ b/types/Balance.d.ts @@ -27,7 +27,7 @@ declare module 'stripe' { available: Array; /** - * Funds held due to negative balances on connected Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property. + * Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property. */ connect_reserved?: Array; diff --git a/types/BankAccounts.d.ts b/types/BankAccounts.d.ts index fb30452383..a567875c65 100644 --- a/types/BankAccounts.d.ts +++ b/types/BankAccounts.d.ts @@ -5,11 +5,12 @@ declare module 'stripe' { /** * These bank accounts are payment methods on `Customer` objects. * - * On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer - * destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts). + * On the other hand [External Accounts](https://stripe.com/api#external_accounts) are transfer + * destinations on `Account` objects for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + * is `application`, which includes [Custom accounts](https://stripe.com/connect/custom-accounts). * They can be bank accounts or debit cards as well, and are documented in the links above. * - * Related guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers) + * Related guide: [Bank debits and transfers](https://stripe.com/payments/bank-debits-transfers) */ interface BankAccount { /** diff --git a/types/Capabilities.d.ts b/types/Capabilities.d.ts index a4d189d558..faeaabe795 100644 --- a/types/Capabilities.d.ts +++ b/types/Capabilities.d.ts @@ -226,13 +226,13 @@ declare module 'stripe' { currently_due: Array; /** - * If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. + * If the capability is disabled, this string describes why. Can be `requirements.fields_needed`, `pending.onboarding`, `pending.review`, `rejected.fraud`, `rejected.other`, `platform_paused`, `action_required.requested_capabilities`, `rejected.inactivty`, or `rejected.unsupported_business`. * - * `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service: + * `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service, such as in [Afterpay Clearpay's terms of service](https://stripe.com/afterpay-clearpay/legal#restricted-businesses). * - * - [Afterpay Clearpay's terms of service](https://stripe.com/afterpay-clearpay/legal#restricted-businesses) + * `rejected.inactivity` means that the capability has been paused for inactivity. This disabled reason currently only applies to the Issuing capability. See [Issuing: Managing Inactive Connects](https://support.stripe.com/questions/issuing-managing-inactive-connect-accounts) for more details. * - * If you believe that the rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance. + * If you believe that a rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance. */ disabled_reason: string | null; diff --git a/types/Cards.d.ts b/types/Cards.d.ts index 344bbcd888..3d61af3f9c 100644 --- a/types/Cards.d.ts +++ b/types/Cards.d.ts @@ -21,7 +21,7 @@ declare module 'stripe' { object: 'card'; /** - * The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. + * The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ account?: string | Stripe.Account | null; @@ -81,7 +81,7 @@ declare module 'stripe' { country: string | null; /** - * Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. + * Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ currency?: string | null; @@ -96,7 +96,7 @@ declare module 'stripe' { cvc_check: string | null; /** - * Whether this card is the default external account for its currency. + * Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ default_for_currency?: boolean | null; diff --git a/types/Checkout/Sessions.d.ts b/types/Checkout/Sessions.d.ts index f72b44ca38..288c3a0f38 100644 --- a/types/Checkout/Sessions.d.ts +++ b/types/Checkout/Sessions.d.ts @@ -1040,7 +1040,20 @@ declare module 'stripe' { setup_future_usage?: 'none'; } - interface AmazonPay {} + interface AmazonPay { + /** + * Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + */ + setup_future_usage?: AmazonPay.SetupFutureUsage; + } + + namespace AmazonPay { + type SetupFutureUsage = 'none' | 'off_session'; + } interface AuBecsDebit { /** @@ -1405,7 +1418,20 @@ declare module 'stripe' { expires_after_seconds: number | null; } - interface RevolutPay {} + interface RevolutPay { + /** + * Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + */ + setup_future_usage?: RevolutPay.SetupFutureUsage; + } + + namespace RevolutPay { + type SetupFutureUsage = 'none' | 'off_session'; + } interface SepaDebit { /** diff --git a/types/ConfirmationTokens.d.ts b/types/ConfirmationTokens.d.ts index e97043d5dd..164e7870d5 100644 --- a/types/ConfirmationTokens.d.ts +++ b/types/ConfirmationTokens.d.ts @@ -28,7 +28,7 @@ declare module 'stripe' { created: number; /** - * Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. This is set to null once this ConfirmationToken has been used. + * Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. */ expires_at: number | null; diff --git a/types/Entitlements/ActiveEntitlements.d.ts b/types/Entitlements/ActiveEntitlements.d.ts index 2a2e651e04..11ddc2019c 100644 --- a/types/Entitlements/ActiveEntitlements.d.ts +++ b/types/Entitlements/ActiveEntitlements.d.ts @@ -18,9 +18,9 @@ declare module 'stripe' { object: 'entitlements.active_entitlement'; /** - * The feature that the customer is entitled to. + * The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to. */ - feature: string; + feature: string | Stripe.Entitlements.Feature; /** * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. diff --git a/types/EventTypes.d.ts b/types/EventTypes.d.ts index 320e03419b..f7c82c9687 100644 --- a/types/EventTypes.d.ts +++ b/types/EventTypes.d.ts @@ -520,7 +520,7 @@ declare module 'stripe' { } /** - * Occurs when funds are reinstated to your account after a dispute is closed. This includes [partially refunded payments](/docs/disputes#disputes-on-partially-refunded-payments). + * Occurs when funds are reinstated to your account after a dispute is closed. This includes [partially refunded payments](https://docs.stripe.com/disputes#disputes-on-partially-refunded-payments). */ interface ChargeDisputeFundsReinstatedEvent extends EventBase { type: 'charge.dispute.funds_reinstated'; @@ -1128,7 +1128,7 @@ declare module 'stripe' { } /** - * Occurs whenever a customer's subscription is paused. Only applies when subscriptions enter `status=paused`, not when [payment collection](/docs/billing/subscriptions/pause) is paused. + * Occurs whenever a customer's subscription is paused. Only applies when subscriptions enter `status=paused`, not when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is paused. */ interface CustomerSubscriptionPausedEvent extends EventBase { type: 'customer.subscription.paused'; @@ -1176,7 +1176,7 @@ declare module 'stripe' { } /** - * Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](/docs/api/subscriptions/resume), not when [payment collection](/docs/billing/subscriptions/pause) is resumed. + * Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](https://docs.stripe.com/api/subscriptions/resume), not when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is resumed. */ interface CustomerSubscriptionResumedEvent extends EventBase { type: 'customer.subscription.resumed'; @@ -1550,7 +1550,7 @@ declare module 'stripe' { } /** - * Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see [Using Webhooks with Subscriptions](/docs/subscriptions/webhooks). + * Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see [Using Webhooks with Subscriptions](https://docs.stripe.com/subscriptions/webhooks). */ interface InvoiceCreatedEvent extends EventBase { type: 'invoice.created'; @@ -1566,7 +1566,7 @@ declare module 'stripe' { } /** - * Occurs whenever a draft invoice is deleted. + * Occurs whenever a draft invoice is deleted. Note: This event is not sent for [invoice previews](https://docs.stripe.com/api/invoices/create_preview). */ interface InvoiceDeletedEvent extends EventBase { type: 'invoice.deleted'; @@ -1582,7 +1582,7 @@ declare module 'stripe' { } /** - * Occurs whenever a draft invoice cannot be finalized. See the invoice’s [last finalization error](/docs/api/invoices/object#invoice_object-last_finalization_error) for details. + * Occurs whenever a draft invoice cannot be finalized. See the invoice’s [last finalization error](https://docs.stripe.com/api/invoices/object#invoice_object-last_finalization_error) for details. */ interface InvoiceFinalizationFailedEvent extends EventBase { type: 'invoice.finalization_failed'; @@ -1806,7 +1806,7 @@ declare module 'stripe' { } /** - * Represents a synchronous request for authorization, see [Using your integration to handle authorization requests](/docs/issuing/purchases/authorizations#authorization-handling). + * Represents a synchronous request for authorization, see [Using your integration to handle authorization requests](https://docs.stripe.com/issuing/purchases/authorizations#authorization-handling). */ interface IssuingAuthorizationRequestEvent extends EventBase { type: 'issuing_authorization.request'; @@ -2062,7 +2062,7 @@ declare module 'stripe' { } /** - * Occurs when a PaymentIntent has funds to be captured. Check the `amount_capturable` property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an `amount_to_capture` value up to the specified amount. [Learn more about capturing PaymentIntents.](https://stripe.com/docs/api/payment_intents/capture) + * Occurs when a PaymentIntent has funds to be captured. Check the `amount_capturable` property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an `amount_to_capture` value up to the specified amount. [Learn more about capturing PaymentIntents.](https://docs.stripe.com/api/payment_intents/capture) */ interface PaymentIntentAmountCapturableUpdatedEvent extends EventBase { type: 'payment_intent.amount_capturable_updated'; @@ -2270,7 +2270,7 @@ declare module 'stripe' { } /** - * Occurs whenever a payment method is updated via the [PaymentMethod update API](https://stripe.com/docs/api/payment_methods/update). + * Occurs whenever a payment method is updated via the [PaymentMethod update API](https://docs.stripe.com/api/payment_methods/update). */ interface PaymentMethodUpdatedEvent extends EventBase { type: 'payment_method.updated'; diff --git a/types/Events.d.ts b/types/Events.d.ts index 7db871b91f..be04fa8864 100644 --- a/types/Events.d.ts +++ b/types/Events.d.ts @@ -285,10 +285,10 @@ declare module 'stripe' { * `Event` objects directly to an endpoint on your server. You can manage * webhooks in your * [account settings](https://dashboard.stripe.com/account/webhooks). Learn how - * to [listen for events](https://stripe.com/docs/webhooks) + * to [listen for events](https://docs.stripe.com/webhooks) * so that your integration can automatically trigger reactions. * - * When using [Connect](https://stripe.com/docs/connect), you can also receive event notifications + * When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications * that occur in connected accounts. For these events, there's an * additional `account` attribute in the received `Event` object. * diff --git a/types/EventsResource.d.ts b/types/EventsResource.d.ts index 91c67d7090..f82714f666 100644 --- a/types/EventsResource.d.ts +++ b/types/EventsResource.d.ts @@ -51,7 +51,7 @@ declare module 'stripe' { ): Promise>; /** - * List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://stripe.com/docs/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header). + * List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header). */ list( params?: EventListParams, diff --git a/types/Identity/VerificationSessions.d.ts b/types/Identity/VerificationSessions.d.ts index db07e12bdd..28a75b6c8c 100644 --- a/types/Identity/VerificationSessions.d.ts +++ b/types/Identity/VerificationSessions.d.ts @@ -73,7 +73,7 @@ declare module 'stripe' { /** * Details provided about the user being verified. These details may be shown to the user. */ - provided_details?: VerificationSession.ProvidedDetails | null; + provided_details: VerificationSession.ProvidedDetails | null; /** * Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. @@ -237,7 +237,7 @@ declare module 'stripe' { /** * The user's verified email address */ - email?: string | null; + email: string | null; /** * The user's verified first name. @@ -262,7 +262,7 @@ declare module 'stripe' { /** * The user's verified phone number */ - phone?: string | null; + phone: string | null; } namespace VerifiedOutputs { diff --git a/types/Identity/VerificationSessionsResource.d.ts b/types/Identity/VerificationSessionsResource.d.ts index bdfb730b01..5f8319a41e 100644 --- a/types/Identity/VerificationSessionsResource.d.ts +++ b/types/Identity/VerificationSessionsResource.d.ts @@ -35,12 +35,12 @@ declare module 'stripe' { return_url?: string; /** - * The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. + * The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`. */ type?: VerificationSessionCreateParams.Type; /** - * The ID of a Verification Flow from the Dashboard. + * The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows. */ verification_flow?: string; } @@ -51,16 +51,6 @@ declare module 'stripe' { * Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document). */ document?: Stripe.Emptyable; - - /** - * Options that apply to the email check. - */ - email?: Stripe.Emptyable; - - /** - * Options that apply to the phone check. - */ - phone?: Stripe.Emptyable; } namespace Options { @@ -89,20 +79,6 @@ declare module 'stripe' { namespace Document { type AllowedType = 'driving_license' | 'id_card' | 'passport'; } - - interface Email { - /** - * Request one time password verification of `provided_details.email`. - */ - require_verification?: boolean; - } - - interface Phone { - /** - * Request one time password verification of `provided_details.phone`. - */ - require_verification?: boolean; - } } interface ProvidedDetails { @@ -160,16 +136,6 @@ declare module 'stripe' { * Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document). */ document?: Stripe.Emptyable; - - /** - * Options that apply to the email check. - */ - email?: Stripe.Emptyable; - - /** - * Options that apply to the phone check. - */ - phone?: Stripe.Emptyable; } namespace Options { @@ -198,20 +164,6 @@ declare module 'stripe' { namespace Document { type AllowedType = 'driving_license' | 'id_card' | 'passport'; } - - interface Email { - /** - * Request one time password verification of `provided_details.email`. - */ - require_verification?: boolean; - } - - interface Phone { - /** - * Request one time password verification of `provided_details.phone`. - */ - require_verification?: boolean; - } } interface ProvidedDetails { diff --git a/types/InvoiceLineItems.d.ts b/types/InvoiceLineItems.d.ts index 0a21bd4420..fa0edd1a33 100644 --- a/types/InvoiceLineItems.d.ts +++ b/types/InvoiceLineItems.d.ts @@ -67,7 +67,7 @@ declare module 'stripe' { livemode: boolean; /** - * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created. + * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation. */ metadata: Stripe.Metadata; diff --git a/types/Invoices.d.ts b/types/Invoices.d.ts index 0736569370..dce82c3423 100644 --- a/types/Invoices.d.ts +++ b/types/Invoices.d.ts @@ -1144,6 +1144,7 @@ declare module 'stripe' { | 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' + | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' @@ -1162,6 +1163,7 @@ declare module 'stripe' { | 'paynow' | 'paypal' | 'promptpay' + | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' diff --git a/types/InvoicesResource.d.ts b/types/InvoicesResource.d.ts index e16dcc7ab5..2465f60ddc 100644 --- a/types/InvoicesResource.d.ts +++ b/types/InvoicesResource.d.ts @@ -482,6 +482,7 @@ declare module 'stripe' { | 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' + | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' @@ -500,6 +501,7 @@ declare module 'stripe' { | 'paynow' | 'paypal' | 'promptpay' + | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' @@ -1156,6 +1158,7 @@ declare module 'stripe' { | 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' + | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' @@ -1174,6 +1177,7 @@ declare module 'stripe' { | 'paynow' | 'paypal' | 'promptpay' + | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' @@ -5210,7 +5214,7 @@ declare module 'stripe' { expand?: Array; /** - * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For `type=recurring` line items, the incoming metadata specified on the request is directly used to set this value, in contrast to `type=invoiceitem` line items, where any existing metadata on the invoice line is merged with the incoming data. */ metadata?: Stripe.Emptyable; @@ -5571,7 +5575,7 @@ declare module 'stripe' { * * Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount. * - * You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date value passed in the request. + * You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request. */ retrieveUpcoming( params?: InvoiceRetrieveUpcomingParams, diff --git a/types/LoginLinks.d.ts b/types/LoginLinks.d.ts index 2b5d31a04f..18df17840a 100644 --- a/types/LoginLinks.d.ts +++ b/types/LoginLinks.d.ts @@ -3,7 +3,7 @@ declare module 'stripe' { namespace Stripe { /** - * Login Links are single-use login link for an Express account to access their Stripe dashboard. + * Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](https://stripe.com/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard. */ interface LoginLink { /** diff --git a/types/Mandates.d.ts b/types/Mandates.d.ts index 0058888f18..27b709e2b9 100644 --- a/types/Mandates.d.ts +++ b/types/Mandates.d.ts @@ -90,6 +90,8 @@ declare module 'stripe' { interface PaymentMethodDetails { acss_debit?: PaymentMethodDetails.AcssDebit; + amazon_pay?: PaymentMethodDetails.AmazonPay; + au_becs_debit?: PaymentMethodDetails.AuBecsDebit; bacs_debit?: PaymentMethodDetails.BacsDebit; @@ -102,6 +104,8 @@ declare module 'stripe' { paypal?: PaymentMethodDetails.Paypal; + revolut_pay?: PaymentMethodDetails.RevolutPay; + sepa_debit?: PaymentMethodDetails.SepaDebit; /** @@ -143,6 +147,8 @@ declare module 'stripe' { type TransactionType = 'business' | 'personal'; } + interface AmazonPay {} + interface AuBecsDebit { /** * The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. @@ -201,6 +207,8 @@ declare module 'stripe' { payer_id: string | null; } + interface RevolutPay {} + interface SepaDebit { /** * The unique reference of the mandate. diff --git a/types/PaymentIntents.d.ts b/types/PaymentIntents.d.ts index 537d66ed45..86dd416572 100644 --- a/types/PaymentIntents.d.ts +++ b/types/PaymentIntents.d.ts @@ -1440,6 +1440,19 @@ declare module 'stripe' { * Controls when the funds will be captured from the customer's account. */ capture_method?: 'manual'; + + /** + * Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + */ + setup_future_usage?: AmazonPay.SetupFutureUsage; + } + + namespace AmazonPay { + type SetupFutureUsage = 'none' | 'off_session'; } interface AuBecsDebit { @@ -2089,6 +2102,19 @@ declare module 'stripe' { * Controls when the funds will be captured from the customer's account. */ capture_method?: 'manual'; + + /** + * Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + */ + setup_future_usage?: RevolutPay.SetupFutureUsage; + } + + namespace RevolutPay { + type SetupFutureUsage = 'none' | 'off_session'; } interface SepaDebit { diff --git a/types/PaymentMethodConfigurations.d.ts b/types/PaymentMethodConfigurations.d.ts index 74f14b6277..45680cde7c 100644 --- a/types/PaymentMethodConfigurations.d.ts +++ b/types/PaymentMethodConfigurations.d.ts @@ -99,6 +99,8 @@ declare module 'stripe' { */ livemode: boolean; + mobilepay?: PaymentMethodConfiguration.Mobilepay; + /** * The configuration's name. */ @@ -985,6 +987,40 @@ declare module 'stripe' { } } + interface Mobilepay { + /** + * Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + */ + available: boolean; + + display_preference: Mobilepay.DisplayPreference; + } + + namespace Mobilepay { + interface DisplayPreference { + /** + * For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + */ + overridable: boolean | null; + + /** + * The account's display preference. + */ + preference: DisplayPreference.Preference; + + /** + * The effective display preference value. + */ + value: DisplayPreference.Value; + } + + namespace DisplayPreference { + type Preference = 'none' | 'off' | 'on'; + + type Value = 'off' | 'on'; + } + } + interface Oxxo { /** * Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. diff --git a/types/PaymentMethodConfigurationsResource.d.ts b/types/PaymentMethodConfigurationsResource.d.ts index 8a573f5dbc..529e18959c 100644 --- a/types/PaymentMethodConfigurationsResource.d.ts +++ b/types/PaymentMethodConfigurationsResource.d.ts @@ -138,6 +138,11 @@ declare module 'stripe' { */ link?: PaymentMethodConfigurationCreateParams.Link; + /** + * MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. + */ + mobilepay?: PaymentMethodConfigurationCreateParams.Mobilepay; + /** * Configuration name. */ @@ -730,6 +735,26 @@ declare module 'stripe' { } } + interface Mobilepay { + /** + * Whether or not the payment method should be displayed. + */ + display_preference?: Mobilepay.DisplayPreference; + } + + namespace Mobilepay { + interface DisplayPreference { + /** + * The account's preference for whether or not to display this payment method. + */ + preference?: DisplayPreference.Preference; + } + + namespace DisplayPreference { + type Preference = 'none' | 'off' | 'on'; + } + } + interface Oxxo { /** * Whether or not the payment method should be displayed. @@ -1119,6 +1144,11 @@ declare module 'stripe' { */ link?: PaymentMethodConfigurationUpdateParams.Link; + /** + * MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. + */ + mobilepay?: PaymentMethodConfigurationUpdateParams.Mobilepay; + /** * Configuration name. */ @@ -1706,6 +1736,26 @@ declare module 'stripe' { } } + interface Mobilepay { + /** + * Whether or not the payment method should be displayed. + */ + display_preference?: Mobilepay.DisplayPreference; + } + + namespace Mobilepay { + interface DisplayPreference { + /** + * The account's preference for whether or not to display this payment method. + */ + preference?: DisplayPreference.Preference; + } + + namespace DisplayPreference { + type Preference = 'none' | 'off' | 'on'; + } + } + interface Oxxo { /** * Whether or not the payment method should be displayed. @@ -1947,7 +1997,7 @@ declare module 'stripe' { } } - interface PaymentMethodConfigurationListParams { + interface PaymentMethodConfigurationListParams extends PaginationParams { /** * The Connect application to filter by. */ diff --git a/types/Persons.d.ts b/types/Persons.d.ts index 7d3708913d..013c2cd716 100644 --- a/types/Persons.d.ts +++ b/types/Persons.d.ts @@ -25,10 +25,9 @@ declare module 'stripe' { /** * This is an object representing a person associated with a Stripe account. * - * A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. - * See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps. + * A platform cannot access a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. * - * Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/handling-api-verification#person-information) + * See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information). */ interface Person { /** diff --git a/types/PricesResource.d.ts b/types/PricesResource.d.ts index 0d4386bac3..2c6e280555 100644 --- a/types/PricesResource.d.ts +++ b/types/PricesResource.d.ts @@ -91,7 +91,7 @@ declare module 'stripe' { transform_quantity?: PriceCreateParams.TransformQuantity; /** - * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `custom_unit_amount` is required, unless `billing_scheme=tiered`. + * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`. */ unit_amount?: number; diff --git a/types/ProductsResource.d.ts b/types/ProductsResource.d.ts index 14996e47be..bad62e7115 100644 --- a/types/ProductsResource.d.ts +++ b/types/ProductsResource.d.ts @@ -416,7 +416,7 @@ declare module 'stripe' { interface ProductCreateFeatureParams { /** - * The ID of the [Feature](docs/api/entitlements/feature) object attached to this product. + * The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product. */ entitlement_feature: string; diff --git a/types/SetupAttempts.d.ts b/types/SetupAttempts.d.ts index 39cb5bc7de..8353b3b0fa 100644 --- a/types/SetupAttempts.d.ts +++ b/types/SetupAttempts.d.ts @@ -92,6 +92,8 @@ declare module 'stripe' { interface PaymentMethodDetails { acss_debit?: PaymentMethodDetails.AcssDebit; + amazon_pay?: PaymentMethodDetails.AmazonPay; + au_becs_debit?: PaymentMethodDetails.AuBecsDebit; bacs_debit?: PaymentMethodDetails.BacsDebit; @@ -114,6 +116,8 @@ declare module 'stripe' { paypal?: PaymentMethodDetails.Paypal; + revolut_pay?: PaymentMethodDetails.RevolutPay; + sepa_debit?: PaymentMethodDetails.SepaDebit; sofort?: PaymentMethodDetails.Sofort; @@ -129,6 +133,8 @@ declare module 'stripe' { namespace PaymentMethodDetails { interface AcssDebit {} + interface AmazonPay {} + interface AuBecsDebit {} interface BacsDebit {} @@ -457,6 +463,8 @@ declare module 'stripe' { interface Paypal {} + interface RevolutPay {} + interface SepaDebit {} interface Sofort { diff --git a/types/Subscriptions.d.ts b/types/Subscriptions.d.ts index 9e73a2b015..01cfc3f665 100644 --- a/types/Subscriptions.d.ts +++ b/types/Subscriptions.d.ts @@ -587,6 +587,7 @@ declare module 'stripe' { | 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' + | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' @@ -605,6 +606,7 @@ declare module 'stripe' { | 'paynow' | 'paypal' | 'promptpay' + | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' diff --git a/types/SubscriptionsResource.d.ts b/types/SubscriptionsResource.d.ts index 7b72d94c26..44ab38f047 100644 --- a/types/SubscriptionsResource.d.ts +++ b/types/SubscriptionsResource.d.ts @@ -752,6 +752,7 @@ declare module 'stripe' { | 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' + | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' @@ -770,6 +771,7 @@ declare module 'stripe' { | 'paynow' | 'paypal' | 'promptpay' + | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' @@ -1605,6 +1607,7 @@ declare module 'stripe' { | 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' + | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' @@ -1623,6 +1626,7 @@ declare module 'stripe' { | 'paynow' | 'paypal' | 'promptpay' + | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' diff --git a/types/Tokens.d.ts b/types/Tokens.d.ts index c3fdddeaac..9b2f66eacb 100644 --- a/types/Tokens.d.ts +++ b/types/Tokens.d.ts @@ -20,7 +20,7 @@ declare module 'stripe' { * * You can't store or use tokens more than once. To store card or bank account * information for later use, create [Customer](https://stripe.com/docs/api#customers) - * objects or [Custom accounts](https://stripe.com/docs/api#external_accounts). + * objects or [External accounts](https://stripe.com/api#external_accounts). * [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection, * performs best with integrations that use client-side tokenization. */ @@ -38,11 +38,12 @@ declare module 'stripe' { /** * These bank accounts are payment methods on `Customer` objects. * - * On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer - * destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts). + * On the other hand [External Accounts](https://stripe.com/api#external_accounts) are transfer + * destinations on `Account` objects for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + * is `application`, which includes [Custom accounts](https://stripe.com/connect/custom-accounts). * They can be bank accounts or debit cards as well, and are documented in the links above. * - * Related guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers) + * Related guide: [Bank debits and transfers](https://stripe.com/payments/bank-debits-transfers) */ bank_account?: Stripe.BankAccount; diff --git a/types/TokensResource.d.ts b/types/TokensResource.d.ts index b55d1d3020..a291144bc4 100644 --- a/types/TokensResource.d.ts +++ b/types/TokensResource.d.ts @@ -890,7 +890,7 @@ declare module 'stripe' { class TokensResource { /** * Creates a single-use token that represents a bank account's details. - * You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [Custom account](https://stripe.com/docs/api#accounts). + * You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts. */ create( params?: TokenCreateParams, diff --git a/types/WebhookEndpoints.d.ts b/types/WebhookEndpoints.d.ts index e905982b48..1e817a0cda 100644 --- a/types/WebhookEndpoints.d.ts +++ b/types/WebhookEndpoints.d.ts @@ -23,13 +23,13 @@ declare module 'stripe' { } /** - * You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be + * You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be * notified about events that happen in your Stripe account or connected * accounts. * * Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints. * - * Related guide: [Setting up webhooks](https://stripe.com/docs/webhooks/configure) + * Related guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure) */ interface WebhookEndpoint { /** @@ -83,7 +83,7 @@ declare module 'stripe' { metadata: Stripe.Metadata; /** - * The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. + * The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation. */ secret?: string;