Address Element

The Address Element is an embeddable UI component for accepting complete addresses. Use it to collect shipping addresses, or when you need a complete billing address, such as for tax purposes.

Get started

You can use the Address Element with either the Checkout elements integration (Elements with Checkout Sessions API) or the Advanced integration (Elements with Payment Intents API). Compare the features and availability to see which integration suits your use case.

Create an Address Element

When you create an Address Element, specify whether to use it in shipping or billing mode.

const stripe = Stripe('pk_test_YVzIqUTwiCYcEXO1DPqDrM98');

const appearance = { /* appearance */ };
const options = { mode: 'shipping' };
const elements = stripe.elements({ 
clientSecret, appearance });
const addressElement = elements.create('address', options);
addressElement.mount('#address-element');

Use Address Element with other elements

You can collect both shipping and billing addresses by using multiple Address Elements, one of each mode, on your page.

If you need to collect both shipping and billing addresses and only want to use one Address Element, use the Address Element in Shipping mode and use the Payment Element to collect only the necessary billing address details.

When you use the Address Element with other elements, you can expect some automatic behavior when confirming the PaymentIntent or SetupIntent. The Address Element validates completeness upon confirming the PaymentIntent or SetupIntent and then displays errors for each field if there are any validation errors.

Use an address

The Address Element automatically works with the Payment or Express Checkout Element. When a customer provides an address and a payment method, Stripe combines them into a single PaymentIntent with the address in the correct field.

Automatic behavior

The elements default behavior depends on its mode.

const stripe = Stripe('pk_test_YVzIqUTwiCYcEXO1DPqDrM98');

const appearance = { /* appearance */ };
const options = { mode: 'shipping' };
const paymentElementOptions = { layout: 'accordion'};
const elements = stripe.elements({ 
clientSecret
 });
const addressElement = elements.create('address', options);
const paymentElement = elements.create('payment', paymentElementOptions);
addressElement.mount('#address-element');
paymentElement.mount('#payment-element');

Custom behavior

Normally, the Address Elements default behavior is enough. But in a complex payment flow, you might need to write custom responses to the customers input. For information, see Listen for address input.

Autocomplete

If your customer selects a supported country for their address, then they see the autocomplete options. The Address Element can autocomplete addresses for the following countries:

If you use the Address Element and the Payment Element together, Stripe enables autocomplete with no configuration required. This is done using a Stripe-provided Google Maps API key.

If you use the Address Element alone, you must use your own Google Maps API Places Library key, which is managed separately from your Stripe account. Pass the key in the autocomplete.apiKey option.

Autofill with Link

Link saves and autofills payment and shipping information for the options youve enabled. For example, if the Link customer has a saved phone number, Stripe autofills the phone number only if phone number collection is enabled. When a returning Link customer authenticates, Stripe autofills their shipping information in the Address element.

[Create a payment form using multiple Elements]

Create a payment form using multiple Elements

To enable autofill, create all elements from the same Elements object, as in this example:

const stripe = Stripe('pk_test_YVzIqUTwiCYcEXO1DPqDrM98');

const appearance = { /* appearance */ };
const options = { mode: 'shipping' };
const paymentElementOptions = { layout: 'accordion'};
const elements = stripe.elements({ 
clientSecret
 });
const linkAuthElement = elements.create('linkAuthentication');
const addressElement = elements.create('address', options);
const paymentElement = elements.create('payment', paymentElementOptions);
linkAuthElement.mount('#link-auth-element');
addressElement.mount('#address-element');
paymentElement.mount('#payment-element');

Appearance

You can use the Appearance API to control the style of all elements. Choose a theme or update specific details.

[Examples of light and dark modes for the address element.]

For instance, choose the flat theme and override the primary text color.

const stripe = Stripe('pk_test_YVzIqUTwiCYcEXO1DPqDrM98');

const appearance = {
  theme: 'flat',
  variables: { colorPrimaryText: '#262626' }
};

See the Appearance API documentation for the Elements with Checkout Sessions API integration or the Advanced integration for a full list of themes and variables.