Collect shipping or billing informationBeta

Enable address collection when you create a Checkout Session:

• To enable shipping address collection when you create a Checkout Session, pass shipping_address_collection. Specify which countries to allow shipping to by configuring the allowed_countries property with an array of two-letter ISO country codes.
• To enable billing address collection when you create a Checkout Session, pass billing_address_collection=required.

const session = await stripe.checkout.sessions.create({
  line_items: [
    {
      price_data: {
        currency: 'usd',
        product_data: {
          name: 'T-shirt',
        },
        unit_amount: 2000,
      },
      quantity: 1,
    },
  ],
  mode: 'payment',
  ui_mode: 'custom',
  return_url: '{{RETURN_URL}}',
  billing_address_collection: 'required',
  shipping_address_collection: {
    allowed_countries: ['US'],
  },
});

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.

You can collect both shipping and billing addresses by using multiple Address Elements on your page.

If you prefer to build your own address form, you can render a custom form for address collection.

<div id="shipping-address"></div>
<div id="billing-address"></div>

const shippingAddressElement = checkout.createElement('address', {mode: 'shipping'});
shippingAddressElement.mount('#shipping-address');

const billingAddressElement = checkout.createElement('address', {mode: 'billing'});
billingAddressElement.mount('#billing-address');