---
page_title: The customer object
product: LotusPay
platform: Web
page_source: https://juspay.io/in/docs/lotuspay/web/core-resources/the-customer-object
llms_txt: https://juspay.io/in/docs/llms.txt
product_llms_txt: https://juspay.io/in/docs/lotuspay/llms.txt
---


# **Customers** 



`customer` objects hold the contact details for a customer. They allow you to track multiple `ach_debit`, `bank_account`, `mandate` and `subscription` objects that are associated with the same customer. The API allows you to retrieve your customers. You can retrieve individual customers as well as a list of all your customers.


### **The customer object** 



**ATTRIBUTES** 


| Attribute | Description |
|---|---|
| id string	 | Unique identifier for the object. |
| object string, value is "customer"	 | String representing the object's type. Objects of the same type share the same value. |
| created timestamp	 | Time at which the object was created. Measured in seconds since the Unix epoch. |
| livemode boolean	 | Has the value true if the object exists in live mode or the value false if the object exists in test mode. |
| metadata hash	 | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
| bank_accounts list	 | The customer's bank accounts, if any. See child attributes below. |
| description string	 | An arbitrary string attached to the object. Often useful for displaying to users. |
| email string	 | Customer’s email address. |
| identification string	 | Customer's identification number e.g. Permanent Account Number (tax ID in India). |
| mandates list	 | The customer's NACH Debit mandates, if any. See child attributes below. |
| mobile string	 | Customer's mobile number (including country code). |
| name string	 | Customer's name. |
| phone string	 | Customer's phone. |
| subscriptions list	 | The customer's subscriptions, if any. See child attributes below. |


Child attributes for lists of linked `bank_accounts`, `mandates` and `subscriptions`:


| Attribute | Description |
|---|---|
| object string, value is list	 | String representing the object’s type. Objects of the same type share the same value. Always has the value list. |
| data array	 | The list contains all related objects that have been attached to the customer. |
| total_count integer	 | The total number of items in the array. |
| url string	 | The URL where this list can be accessed. |


## Sample Code Snippets:
### Example Response:

#### Response:
```json
{
    "id": "CU004433221AA",
    "object": "customer",
    "created": 1530224170,
    "livemode": false,
    "metadata": {
    },
    "bank_accounts": {
      "object": "list",
      "data": [
      {
          "id": "BA0011223344BB"
      }
      ],
      "total_count": 1,
      "url": "/v1/customers/CU004433221AA/bank_accounts"
    },
    "description": null,
    "email": "amit@gmail.com",
    "identification": "ABCDE1234A",
    "mandates": {
      "object": "list",
      "data": [
          {
              "id": "MD0011223366A"
          },
          {
              "id": "MD00123459DDA"
          }
      ],
      "total_count": 2,
      "url": "/v1/customers/CU004433221AA/mandates"
      },
    "mobile": "9123456789",
    "name": "Amit Jain",
    "phone": "9123456789",
    "subscriptions": {
      "object": "list",
      "data": [
          {
              "id": "SB0011223322D"
          }
      ],
      "total_count": 1,
      "url": "/v1/customers/CU004433221AA/subscriptions"
    }
  }
```



---

## See Also

- [List all NACH banks](https://juspay.io/in/docs/lotuspay/web/core-resources/list-all-nach-banks)
- [Create a customer](https://juspay.io/in/docs/lotuspay/web/core-resources/create-a-customer)