The Elements object Stripe Elements are customizable UI components used to collect sensitive information in your payment forms. Use an Elements instance to create and manage a group of individual Element instances. ## Create an Elements instance stripe.elements(options?: object) This method creates an Elements instance, which manages a group of elements. For the Payment Element created without an Intent and the Express Checkout Element, see the Elements object without an Intent reference instead. - options A set of options to create this Elements instance with. - fonts An array of custom fonts, which elements created from the Elements object can use. Fonts can be specified as CssFontSource or CustomFontSource objects. - locale A locale to display placeholders and error strings in. Default is auto (Stripe detects the locale of the browser). Setting the locale does not affect the behavior of postal code validation—a valid postal code for the billing country of the card is still required. To indicate the direction of text for right to left languages such as Arabic and Hebrew, mount Elements underneath an HTML element that includes the dir="rtl" attribute. - clientSecret Required to use with the Payment Element and the Contact Details Element. The client secret for a PaymentIntent or SetupIntent. - appearance Supported for the Payment Element, the Contact Details Element, and the Address Element. Match the design of your site with the appearance option. The layout of each Element stays consistent, but you can modify colors, fonts, borders, padding, and more. - loader Supported for the Payment Element, the Contact Details Element, and the Address Element. Display skeleton loader UI while waiting for Elements to be fully loaded, after they are mounted. Default is 'auto' (Stripe determines if a loader UI should be shown). - currency Used with the Payment Element. Influences available payment methods when creating SetupIntents with automatic_payment_methods. Payment Element renders the payment methods enabled in the Stripe Dashboard that support the provided currency. Three-letter ISO currency code, in lowercase. Must be a supported currency. - customerSessionClientSecret Used with the Payment Element and Address Element. The client_secret returned from create a CustomerSession associated with the Customer ID for that session. - syncAddressCheckbox Used with the Address Element. The syncAddressCheckbox parameter configures which Address Element to show the checkbox above. The checkbox allows the customer the option to sync billing and shipping addresses when multiple Address Elements are used, one of each mode, in a single Elements instance. Default is 'billing'. 'none' opts out of showing the checkbox in either Address Element. - paymentMethodCreation Used with the Payment Element and Express Checkout Element. Allows PaymentMethods to be created from the Elements instance using stripe.createPaymentMethod. NOTE: The Express Checkout Element doesn't support stripe.createPaymentMethod with Amazon Pay or Klarna. Use stripe.createConfirmationToken instead. Card installments are also unsupported and either blocks showing the plan selection UI, or raises an error for manual enablement using paymentMethodOptions. - customPaymentMethods Supported for the Payment Element and Express Checkout Element. An array of custom payment methods to display in the Payment Element or Express Checkout Element. The custom payment methods must be registered in the Stripe Dashboard. - id The ID of the custom payment method type, prefixed with cpmt_. - options A set of options that configure the custom payment method. options and payment are mutually exclusive. - type The form type of the custom payment method. - subtitle A subtitle contains additional information about the custom payment method. - payment A set of options that configure the custom payment method in the Payment Element. This is an alias of options. payment and options are mutually exclusive. - type The form type of the custom payment method. - subtitle A subtitle contains additional information about the custom payment method. - externalPaymentMethodTypes (deprecated)This param has been deprecated in favor of custom payment methods, which offers more flexibility. The external payment methods to be displayed in the Payment Element that you are already integrated with. Must be an available external payment methods. ### Example title Create an Elements instance ## Create an Elements instance without an intent stripe.elements(options?: object) This method creates an Elements instance, which manages a group of elements. This reference applies to the Payment Element created without an Intent, Express Checkout Element, and Card Elements. For other elements, see the Elements object reference instead. - options A set of options to create this Elements instance with. - fonts An array of custom fonts, which elements created from the Elements object can use. Fonts can be specified as CssFontSource or CustomFontSource objects. - locale A locale to display placeholders and error strings in. Default is auto (Stripe detects the locale of the browser). Setting the locale does not affect the behavior of postal code validation—a valid postal code for the billing country of the card is still required. To indicate the direction of text for right to left languages such as Arabic and Hebrew, mount Elements underneath an HTML element that includes the dir="rtl" attribute. - mode Required to use with the Payment Element and Express Checkout Element. Filters out payment methods based on intended use. - currency Required to use with the Payment Element and Express Checkout Element. Three-letter ISO currency code, in lowercase. Must be a supported currency. - amount Used with the Payment Element and Express Checkout Element. Required when mode is payment or subscription. Shown in Apple Pay, Google Pay, or Buy now, pay later UIs. The amount intended to be collected from the customer right now. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD or 100 to charge 100 JPY, a zero-decimal currency). The minimum amount is 0.50 USD or equivalent in charge currency. If mode is subscription, the value supports 0 to account for coupons and free trials, but any amount above 0 is subject to the minimum. The amount value supports up to eight digits (e.g., a value of 99999999 for a 999,999.99 USD charge). - setupFutureUsage Used with the Payment Element and Express Checkout Element. Indicates that you intend to make future payments with the payment details collected by the Payment Element. This should match the setup_future_usage provided on the Intent used when confirming payment. - captureMethod Used with the Payment Element and Express Checkout Element. Influences available payment methods. This should match the capture_method provided on the Intent used when confirming payment. - onBehalfOf Used with the Payment Element, Express Checkout Element, and Card Elements. The Stripe account ID which is the business of record. See use cases to determine if this option is relevant for your integration. This should match the on_behalf_of provided on the Intent used when confirming payment. - paymentMethodTypes Used with the Payment Element and Express Checkout Element. A list of payment method types to render. You can omit this attribute to manage your payment methods from the Stripe Dashboard. - paymentMethodConfiguration Used with the Payment Element and Express Checkout Element. The payment method configuration to use when managing your payment methods from the Stripe Dashboard. If none is specified, your default configuration is used. - paymentMethodOptions Used with the Payment Element and Express Checkout Element. Additional payment-method-specific options for configuring behavior when initialized without an intent. - acss_debit If this is an acss_debit PaymentMethod, this sub-hash contains details about the the related setting Debit payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - affirm If this is an affirm PaymentMethod, this sub-hash contains details about the Affirm payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - afterpay_clearpay If this is an afterpay_clearpay PaymentMethod, this sub-hash contains details about the Afterpay / Clearpay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - alipay If this is an alipay PaymentMethod, this sub-hash contains details about the Alipay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - amazon_pay If this is an amazon_pay PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - au_becs_debit If this is an au_becs_debit PaymentMethod, this sub-hash contains details about the the related setting Debit payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - bacs_debit If this is a bacs_debit PaymentMethod, this sub-hash contains details about the Bacs Debit payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - bancontact If this is a bancontact PaymentMethod, this sub-hash contains details about the Bancontact payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - blik If this is a blik PaymentMethod, this sub-hash contains details about the the related setting payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - boleto If this is a boleto PaymentMethod, this sub-hash contains details about the Boleto payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - card If this is a card PaymentMethod, this sub-hash contains details about the card payment method options. - require_cvc_recollection When enabled, using a card that is attached to a customer will require the CVC to be provided again. When providing a customerSessionClientSecret and using the Payment Element, the Payment Element will prompt for CVC recollection. - installments Installment configuration. - enabled When true, shows the card installment plan selection UI (depending on issuer and country support) if you don't manage your payment methods in the Stripe Dashboard. You must set mode='payment'and explicitly specify allowedPaymentMethodTypes in the Elements options. Setting installments to true without these settings returns an error. Incompatible with paymentMethodCreation='manual'. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - cashapp If this is a cashapp PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - crypto If this is a crypto PaymentMethod, this sub-hash contains details about the Crypto payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - customer_balance If this is a customer_balance PaymentMethod, this sub-hash contains details about the Customer Balance payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - eps If this is an eps PaymentMethod, this sub-hash contains details about the EPS payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - fpx If this is an fpx PaymentMethod, this sub-hash contains details about the FPX payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - giropay If this is a giropay PaymentMethod, this sub-hash contains details about the giropay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - grabpay If this is a grabpay PaymentMethod, this sub-hash contains details about the GrabPay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - ideal If this is an ideal PaymentMethod, this sub-hash contains details about the iDEAL payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - kakao_pay If this is a kakao_pay PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - klarna If this is a klarna PaymentMethod, this sub-hash contains details about the Klarna payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - konbini If this is a konbini PaymentMethod, this sub-hash contains details about the Konbini payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - kr_card If this is a kr_card PaymentMethod, this sub-hash contains details about the Korean card payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - link If this is a link PaymentMethod, this sub-hash contains details about the Link payment method options (Link is also known as Onelink in the UK). - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - mb_way If this is a mb_way PaymentMethod, this sub-hash contains details about the MB WAY payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - mobilepay If this is a mobilepay PaymentMethod, this sub-hash contains details about the MobilePay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - multibanco If this is a multibanco PaymentMethod, this sub-hash contains details about the Multibanco payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - naver_pay If this is a naver_pay PaymentMethod, this sub-hash contains details about the Naver Pay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - nz_bank_account If this is a nz_bank_account PaymentMethod, this sub-hash contains details about the New Zealand bank account payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - oxxo If this is an oxxo PaymentMethod, this sub-hash contains details about the the related setting payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - p24 If this is a p24 PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - paynow If this is a paynow PaymentMethod, this sub-hash contains details about the PayNow payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - pix If this is a pix PaymentMethod, this sub-hash contains details about the Pix payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - paypal If this is a paypal PaymentMethod, this sub-hash contains details about the PayPal payment method options. - capture_method Controls when the funds will be captured. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - promptpay If this is a promptpay PaymentMethod, this sub-hash contains details about the PromptPay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - revolut_pay If this is a revolut_pay PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - satispay If this is a satispay PaymentMethod, this sub-hash contains details about the Satispay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - sepa_debit If this is a sepa_debit PaymentMethod, this sub-hash contains details about the the related setting Debit payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - sequra If this is a sequra PaymentMethod, this sub-hash contains details about the SeQura payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - sofort If this is a sofort PaymentMethod, this sub-hash contains details about the Sofort payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - sunbit If this is a sunbit PaymentMethod, this sub-hash contains details about the Sunbit payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - swish If this is a swish PaymentMethod, this sub-hash contains details about the Swish payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - twint If this is a twint PaymentMethod, this sub-hash contains details about the the related setting payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - upi If this is a upi PaymentMethod, this sub-hash contains details about the UPI payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - us_bank_account If this is a us_bank_account PaymentMethod, this sub-hash contains details about the US bank account payment method options. - verification_method Verification method for the US bank account collection flow - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - financial_connections Additional fields for Financial Connections session creation - permissions The list of permissions to request. If this parameter is passed, the payment_method permission must be included. Valid permissions include: balances, ownership, payment_method, and transactions. - prefetch The list of permissions that you would like to retrieve upon creation. Valid permissions include: balances, ownership, and transactions. - wechat_pay If this is a wechat_pay PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - zip If this is a zip PaymentMethod, this sub-hash contains details about the Zip payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - appearance Supported for the Payment Element, the Contact Details Element, the Express Checkout Element, and the Address Element. Match the design of your site with the appearance option. The layout of each Element stays consistent, but you can modify colors, fonts, borders, padding, and more. - loader Supported for the Payment Element, the Contact Details Element, and the Address Element. Display skeleton loader UI while waiting for Elements to be fully loaded, after they are mounted. Default is 'auto' (Stripe determines if a loader UI should be shown). - customerSessionClientSecret Used with the Payment Element and Address Element. The client_secret returned from create a CustomerSession associated with the Customer ID for that session. - syncAddressCheckbox Used with the Address Element. The syncAddressCheckbox parameter configures which Address Element to show the checkbox above. The checkbox allows the customer the option to sync billing and shipping addresses when multiple Address Elements are used, one of each mode, in a single Elements instance. Default is 'billing'. 'none' opts out of showing the checkbox in either Address Element. - paymentMethodCreation Used with the Payment Element and Express Checkout Element. Allows PaymentMethods to be created from the Elements instance using stripe.createPaymentMethod. NOTE: The Express Checkout Element doesn't support stripe.createPaymentMethod with Amazon Pay or Klarna. Use stripe.createConfirmationToken instead. Card installments are also unsupported and either blocks showing the plan selection UI, or raises an error for manual enablement using paymentMethodOptions. - allowedPaymentMethodTypes Used with the Payment Element and Express Checkout Element. The list of payment method types to allow for this payment. From this list, Stripe automatically renders the relevant payment methods. You can omit this attribute to manage your payment methods from the Stripe Dashboard. - excludedPaymentMethodTypes Used with the Payment Element and Express Checkout Element. The list of payment method types to exclude from use with this payment. - customPaymentMethods Supported for the Payment Element and Express Checkout Element. An array of custom payment methods to display in the Payment Element or Express Checkout Element. The custom payment methods must be registered in the Stripe Dashboard. - id The ID of the custom payment method type, prefixed with cpmt_. - options A set of options that configure the custom payment method. options and payment are mutually exclusive. - type The form type of the custom payment method. - subtitle A subtitle contains additional information about the custom payment method. - payment A set of options that configure the custom payment method in the Payment Element. This is an alias of options. payment and options are mutually exclusive. - type The form type of the custom payment method. - subtitle A subtitle contains additional information about the custom payment method. ### Example title Create an Elements instance without an intent ## Update Elements Options elements.update(options: object) This method updates options on an existing instance of Elements. Note that not all options are updatable. Starting in Stripe.js dahlia, this method returns a Promise that resolves when the update has been applied to all rendered Elements. You can also listen for the update-end event as an alternative to awaiting the Promise. - options A set of options to update this Elements instance with. - locale A locale to display placeholders and error strings in. Default is auto (Stripe detects the locale of the browser). Setting the locale does not affect the behavior of postal code validation—a valid postal code for the billing country of the card is still required. To indicate the direction of text for right to left languages such as Arabic and Hebrew, mount Elements underneath an HTML element that includes the dir="rtl" attribute. - mode Used with the Payment Element. Filters out payment methods based on intended use. - currency Used with the Payment Element and the Express Checkout Element. Three-letter ISO currency code, in lowercase. Must be a supported currency. - amount Used with the Payment Element and the Express Checkout Element. Shown in Apple Pay, Google Pay, or Buy now pay later UIs. The amount intended to be collected from the customer right now. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - setupFutureUsage Used with the Payment Element and the Express Checkout Element. Influences available payment methods and the terms shown by the Payment Element. This should match the setup_future_usage provided on the Intent used when confirming payment. - captureMethod Used with the Payment Element and the Express Checkout Element. Influences available payment methods. This should match the capture method provided on the PaymentIntent or SetupIntent used when confirming payment. - onBehalfOf Used with the Payment Element and the Express Checkout Element. This property can't be updated when used with the Card Element. The Stripe account ID, which is the business of record. Review the use cases to determine if this option is relevant for your integration. Make sure this matches the on_behalf_of provided on the Intent used when confirming payment. - paymentMethodTypes Used with the Payment Element and the Express Checkout Element. Instead of using dynamic payment methods, declare specific payment methods to enable. - paymentMethodConfiguration Used with the Payment Element and Express Checkout Element. The payment method configuration to use when managing your payment methods from the Stripe Dashboard. If none is specified, your default configuration is used. - paymentMethodOptions Used with the Payment Element and the Express Checkout Element. Additional payment-method-specific options for configuring behavior when initialized without an intent. - acss_debit If this is an acss_debit PaymentMethod, this sub-hash contains details about the the related setting Debit payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - affirm If this is an affirm PaymentMethod, this sub-hash contains details about the Affirm payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - afterpay_clearpay If this is an afterpay_clearpay PaymentMethod, this sub-hash contains details about the Afterpay / Clearpay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - alipay If this is an alipay PaymentMethod, this sub-hash contains details about the Alipay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - alma If this is an alma PaymentMethod, this sub-hash contains details about the Alma payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - amazon_pay If this is an amazon_pay PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - au_becs_debit If this is an au_becs_debit PaymentMethod, this sub-hash contains details about the the related setting Debit payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - bacs_debit If this is a bacs_debit PaymentMethod, this sub-hash contains details about the Bacs Debit payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - bancontact If this is a bancontact PaymentMethod, this sub-hash contains details about the Bancontact payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - billie If this is a billie PaymentMethod, this sub-hash contains details about the Billie payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - blik If this is a blik PaymentMethod, this sub-hash contains details about the the related setting payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - boleto If this is a boleto PaymentMethod, this sub-hash contains details about the Boleto payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - card If this is a card PaymentMethod, this sub-hash contains details about the card payment method options. - require_cvc_recollection When enabled, using a card that is attached to a customer will require the CVC to be provided again. When providing a customerSessionClientSecret and using the Payment Element, the Payment Element will prompt for CVC recollection. - installments Installment configuration. - enabled When true, shows the card installment plan selection UI (depending on issuer and country support) if you don't manage your payment methods in the Stripe Dashboard. You must set mode='payment'and explicitly specify allowedPaymentMethodTypes in the Elements options. Setting installments to true without these settings returns an error. Incompatible with paymentMethodCreation='manual'. - cashapp If this is a cashapp PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - crypto If this is a crypto PaymentMethod, this sub-hash contains details about the Crypto payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - eps If this is an eps PaymentMethod, this sub-hash contains details about the EPS payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - fpx If this is an fpx PaymentMethod, this sub-hash contains details about the FPX payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - giropay If this is a giropay PaymentMethod, this sub-hash contains details about the giropay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - grabpay If this is a grabpay PaymentMethod, this sub-hash contains details about the GrabPay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - ideal If this is an ideal PaymentMethod, this sub-hash contains details about the iDEAL payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - klarna If this is a klarna PaymentMethod, this sub-hash contains details about the Klarna payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - konbini If this is a konbini PaymentMethod, this sub-hash contains details about the Konbini payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - link If this is a link PaymentMethod, this sub-hash contains details about the Link payment method options (Link is also known as Onelink in the UK). - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - mobilepay If this is a mobilepay PaymentMethod, this sub-hash contains details about the MobilePay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - multibanco If this is a multibanco PaymentMethod, this sub-hash contains details about the Multibanco payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - netbanking If this is a netbanking PaymentMethod, this sub-hash contains details about the NetBanking payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - oxxo If this is an oxxo PaymentMethod, this sub-hash contains details about the the related setting payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - p24 If this is a p24 PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - paynow If this is a paynow PaymentMethod, this sub-hash contains details about the PayNow payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - paypal If this is a paypal PaymentMethod, this sub-hash contains details about the PayPal payment method options. - capture_method Controls when the funds will be captured. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - promptpay If this is a promptpay PaymentMethod, this sub-hash contains details about the PromptPay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - revolut_pay If this is a revolut_pay PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - satispay If this is a satispay PaymentMethod, this sub-hash contains details about the Satispay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - sepa_debit If this is a sepa_debit PaymentMethod, this sub-hash contains details about the the related setting Debit payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - sequra If this is a sequra PaymentMethod, this sub-hash contains details about the SeQura payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - sofort If this is a sofort PaymentMethod, this sub-hash contains details about the Sofort payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - sunbit If this is a sunbit PaymentMethod, this sub-hash contains details about the Sunbit payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - swish If this is a swish PaymentMethod, this sub-hash contains details about the Swish payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - twint If this is a twint PaymentMethod, this sub-hash contains details about the the related setting payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - upi If this is a upi PaymentMethod, this sub-hash contains details about the UPI payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - us_bank_account If this is a us_bank_account PaymentMethod, this sub-hash contains details about the US bank account payment method options. - verification_method Verification method for the US bank account collection flow - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - off_session Use off_session if your customer may or may not be present in your checkout flow. - on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. - financial_connections Additional fields for Financial Connections session creation - permissions The list of permissions to request. If this parameter is passed, the payment_method permission must be included. Valid permissions include: balances, ownership, payment_method, and transactions. - prefetch The list of permissions that you would like to retrieve upon creation. Valid permissions include: balances, ownership, and transactions. - wechat_pay If this is a wechat_pay PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - zip If this is a zip PaymentMethod, this sub-hash contains details about the Zip payment method options. - setup_future_usage Indicates that you intend to make future payments with the payment details collected by the Payment Element. - none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method. - appearance Used with the Payment Element and the Express Checkout Element. Match the design of your site with the appearance option. The layout of each Element stays consistent, but you can modify colors, fonts, borders, padding, and more. - fonts An array of custom fonts, which elements created from the Elements object can use. Fonts can be specified as CssFontSource or CustomFontSource objects. Any fonts that have already been loaded during creation or previous updates will be ignored. - customerSessionClientSecret Used with the Payment Element and Address Element. The client_secret returned from create a CustomerSession associated with the Customer ID. When the customerSessionClientSecret is used with element.update(), saved payment methods associated with the previous session are cleared, and the payment element is re-rendered with any saved payment methods associated with the updated secret. - allowedPaymentMethodTypes Used with the Payment Element and the Express Checkout Element. The list of payment method types to allow for this payment. From this list, Stripe automatically renders the relevant payment methods. You can omit this attribute to manage your payment methods from the Stripe Dashboard. - excludedPaymentMethodTypes Used with the Payment Element and the Express Checkout Element. The list of payment method types to exclude from use with this payment. - customPaymentMethods Supported for the Payment Element and Express Checkout Element. An array of custom payment methods to display in the Payment Element or Express Checkout Element. The custom payment methods must be registered in the Stripe Dashboard. - id The ID of the custom payment method type, prefixed with cpmt_. - options A set of options that configure the custom payment method. options and payment are mutually exclusive. - type The form type of the custom payment method. - subtitle A subtitle contains additional information about the custom payment method. - payment A set of options that configure the custom payment method in the Payment Element. This is an alias of options. payment and options are mutually exclusive. - type The form type of the custom payment method. - subtitle A subtitle contains additional information about the custom payment method. ### Example title Update Elements ## Update-end event elements.on(event: 'update-end', handler: function) Triggered when the call to elements.update() is complete. - event The name of the event. In this case, update-end. - handlerhandler() => void is a callback function that you provide that will be called when the event is fired. ### Example title Handle an Elements update-end event ## Fetch Server Updates elements.fetchUpdates() Used with the Payment Element. This method fetches updates from the associated PaymentIntent or SetupIntent on an existing instance of Elements, and reflects these updates in the Payment Element. ### Example title Fetch Server Updates ## Submit elements.submit() Use elements.submit() when creating the Elements object without an Intent. Before confirming a payment, call elements.submit() to validate the form fields and collect any data required for wallets. You must wait for this function's promise to resolve (using async or .then) before performing any other operations. ### Example title Submit Elements
RyzeDesk