Collect customer phone numbers

Collect a phone number for shipping or invoicing when your customer makes a payment.

You can enable phone number collection on all payment and subscription mode Checkout Sessions (phone number collection isn’t supported in setup mode). Only collect phone numbers if you need them for the transaction.

Enable phone number collection
Server-side

To enable phone number collection, set phone_number_collection[enabled] to true when creating a Checkout Session.

Collect the customer's phone number
Client-side

Create a phone number input to collect your customer’s phone number. Call updatePhoneNumber when your customer finishes the input to save the phone number.

Depending on the design of your checkout form, you can call updatePhoneNumber in the following ways:

Directly before submitting the payment.
Before transitioning to the next step, such as clicking a Save button, if your form includes multiple steps.

You’re responsible for validating and formatting phone numbers before calling updatePhoneNumber.

index.html
<input type="tel" id="phone-number" />

checkout.js
stripe.initCheckout({fetchClientSecret}).then((checkout) => {
  const phoneNumberInput = document.getElementById('phone-number');

  phoneNumberInput.addEventListener('blur', () => {
    checkout.updatePhoneNumber(phoneNumberInput.value);
  });
});

Retrieve the phone number
Server-side

After the session, you can retrieve customer phone numbers from the resulting Customer, or Checkout Session objects:

On the Customer: Checkout saves collected phone numbers onto the phone property of the Customer object, which you can access programmatically by either fetching the Customer object directly with the API, or by listening for the customer.created event in a webhook. You can also view the customer’s phone number in the dashboard.
On the Checkout Session: The customer’s phone number is also saved in the customer_details hash of the Checkout Session object, under customer_details.phone. After each successful Checkout Session, Stripe emits the checkout.session.completed event containing the Checkout Session object (and phone number), which you can listen for in a webhook.

Collect customer phone numbers

Collect a phone number for shipping or invoicing when your customer makes a payment.

Enable phone number collectionServer-side

Collect the customer's phone numberClient-side

Retrieve the phone numberServer-side

Enable phone number collection
Server-side

Collect the customer's phone number
Client-side

Retrieve the phone number
Server-side