Customers

POST /v1/customers

Cria um novo cliente.

Request body

Campo	Tipo	Obrigatório	Descrição
email	string	✓	Email do cliente
name	string		Nome completo
document	string		CPF ou CNPJ
phone	string		Telefone
metadata	object		Dados extras (key-value strings)

Exemplo

curl -X POST https://api.kirvex.com.br/v1/customers \
  -u sk_test_...: \
  -H "Content-Type: application/json" \
  -d '{
    "email": "joao@example.com",
    "name": "João Silva",
    "document": "12345678900"
  }'

Resposta (201)

{
  "id": "cus_01J...",
  "object": "customer",
  "email": "joao@example.com",
  "name": "João Silva",
  "document": "12345678900",
  "phone": null,
  "metadata": null,
  "created_at": "2026-04-29T12:00:00Z",
  "updated_at": "2026-04-29T12:00:00Z"
}

---

GET /v1/customers/:id

Retorna um cliente pelo ID.

---

GET /v1/customers

Lista clientes com paginação por cursor.

Query params

Campo	Tipo	Descrição
cursor	string	Cursor da página anterior
limit	number	Máximo de resultados (1–100, default 20)
email	string	Filtrar por email
document	string	Filtrar por CPF/CNPJ

---

PATCH /v1/customers/:id

Atualiza campos de um cliente.

---

DELETE /v1/customers/:id

Remove um cliente. Retorna { "id": "cus_...", "deleted": true }.