> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dexpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Referência

> Gerencie seus clientes, aqueles que pagam você.

Um cliente é seu usuário final, aquele que você vai cobrar e pagar o seu produto.

## <Icon icon="folder-tree" type="solid" />  Estrutura

Um cliente é representado em nossa API pela seguinte estrutura:

```json theme={null}
{
  "id": "cust_aebxkhDZNaMmJeKsy0AHS0FQ",
  "metadata": {
    "name": "Test Customer",
    "cellphone": "11999999999",
    "taxId": "12345678900",
    "email": "test@example.com"
  }
} 
```

## Atributos

### id:

```json {2} theme={null}
{
  "id": "cust_aebxkhDZNaMmJeKsy0AHS0FQ",
} 
```

`id` : <u> string. </u> <br />
Id único do cliente na AbacatePay

### metadados:

Objeto com os dados do cliente

```json json {2-7} theme={null}
{
  "metadata": {
    "name": "Test Customer",
    "cellphone": "11999999999",
    "taxId": "12345678900",
    "email": "test@example.com"
  }
} 
```

* `name` : <u> string. </u> <br /> Nome do cliente (opcional)

* `cellphone` : <u> string. </u> <br /> Telefone do cliente (opcional)

* `taxId` : <u> string. </u> <br /> Documento válido do cliente, podendo ser CPF ou CNPJ (opcional)

* `email` : <u> string. </u> <br /> E-mail do cliente (obrigatório)

<Tip title="Clientes são únicos por CPF" icon="book" horizontal>
  Não é possível criar um cliente com CPF inválido e caso já exista um cliente com esse CPF, a API não criará o cliente novo.
</Tip>
