Collect Customer Information

Enable your checkout page to collect additional customer information, such as Name, Phone numbers, or Address directly within the payment flow. Activated via the request body when creating a checkout session.

---

Overview

By default, the checkout page collects only the payment details required to complete a transaction. Merchants can extend this by enabling collect_customer in the creation request. When enabled, the configured fields appear as a form step inside the checkout flow before payment is processed.

How to Enable Customer Data Collection

Pass the collect_customer object inside your Request Body to Checkout Page

...
"collect_customer": {
    "name": true,
    "email" : true,
    "phone" : true,
    "address" : true
  }
...

Body Parameter	Type	Mandatory	Description
collect_customer.name	boolean	Optional	When set to true, a name input field is displayed on the checkout page, prompting the customer to enter their full name before proceeding to payment.
collect_customer.email	boolean	Optional	When set to true, an email input field is displayed on the checkout page. The collected email can be used for payment confirmation and receipt delivery.
collect_customer.phone	boolean	Optional	When set to true, a phone number input field is displayed on the checkout page. Useful for merchants who require contact information for order updates or delivery coordination.
collect_customer.address	boolean	Optional	When set to true, an address input field is displayed on the checkout page. Recommended for merchants with physical goods delivery that need a shipping destination at the point of payment.

How The Checkout Preview

Before

After