Collect physical addresses

When you use a Stripe-hosted payment page or embedded payment form, you can collect billing and shipping addresses.

Collect a billing address

By default, a Checkout Session only collects a customer’s billing address when necessary (for example, to calculate tax). To always collect a billing address, set billing_address_collection to required when you create a Checkout Session.

curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d billing_address_collection=required \
  -d "automatic_tax[enabled]"=true \
  -d mode=payment \
  --data-urlencode success_url="https://example.com/success"

Collect a shipping address

To collect a customer’s shipping address in Checkout, pass the shipping_address_collection parameter when you create a Checkout Session. When you collect a shipping address, you must also specify which countries to allow shipping to. Configure the allowed_countries property with an array of two-letter ISO country codes.

curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d billing_address_collection=required \
  -d "shipping_address_collection[allowed_countries][]"=US \
  -d "shipping_address_collection[allowed_countries][]"=CA \
  -d "automatic_tax[enabled]"=true \
  -d mode=payment \
  --data-urlencode success_url="https://example.com/success"

When the customer completes the session, the Checkout Session object saves the collected shipping address on the shipping_details property and includes it in the payload of the checkout.session.completed webhook. You can also see shipping information in the Dashboard on the payment details page.