API ReferenceIntegrationsKnowledge Base

Customers

You can create customers with basic details such as name and contact details and use them for various Razorpay solution offerings.

Customer Entity#

Customer entity consists of the following fields:

id
string Razorpay customer ID.
name
string Customer's name. Alphanumeric, with period (.), apostrophe (') and parantheses allowed. Max length: 50.
contact
string Customer's contact number.
email
string Customer's email ID.
notes
dictionary Contains user defined fields, stored for reference purposes. Refer the notes section in API documentation for more information.
created_at
integer Unix timestamp indicating when the customer was created.

Create a Customer#

You can create a customer via APIs or from the Dashboard. The following section will explain the API for creating a customer:

/customers

Note:
If a customer already exists with the same details, the request throws an exception by default. You can pass additional parameter fail_existing (string, 0/1) to get the existing customer details in the output.

Edit a Customer#

You can edit a customer via the API or from the Dashboard. The following section will explain the API for editing a customer:

/customers/:id

Note:
You can update name, email or contact of the customer. The email and contact information combination must be unique to the customer.

Fetch all Customers#

The following section will explain the API for fetching multiple customers:

/customers

Fetch a Customer#

The following section will explain the API for fetching a customer by its ID:

/customers/:id