Crie, liste e consulte clientes dentro da conta e ambiente da chave.

Recursos disponíveis na v1

Todas as rotas de integração exigem Bearer API key. A chave define conta e ambiente. As operações de escrita exigem o scope indicado e Idempotency-Key.

Clientes

Listar clientes

GET/v1/customers

Lista até 100 clientes pertencentes à conta e ao ambiente da chave. Scope: customers:read. A resposta contém a lista em data e o identificador de correlação em meta.request_id.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "id": "cus_…",
      "name": "Cliente",
      "email": "[email protected]",
      "created_at": "2026-01-01T10:00:00Z"
    }
  ],
  "meta": { "request_id": "req_…" }
}

Criar cliente

POST/v1/customers

Cria um cliente. Scope: customers:write. Campos aceites: name obrigatório (1–200 caracteres) e email opcional (até 320 caracteres). O email, quando enviado, tem de ser válido. Envie Idempotency-Key.

curl -i -X POST \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: customer-order-1042' \
  --data '{"name":"Cliente","email":"[email protected]"}' \
  "https://api-pay.edutecka.com/v1/customers"

HTTP/1.1 201 Created
Content-Type: application/json

{
  "data": {
    "id": "cus_…",
    "name": "Cliente",
    "email": "[email protected]",
    "created_at": "2026-01-01T10:00:00Z"
  },
  "meta": { "request_id": "req_…" }
}

Consultar cliente

GET/v1/customers/{id}

Obtém um cliente pertencente à conta e ao ambiente da chave. Scope: customers:read. Um ID de outra conta ou ambiente responde como não encontrado.

Actualizar cliente

PATCH/v1/customers/{id}

Actualiza parcialmente name e/ou email. Scope: customers:write; requer Idempotency-Key. Para limpar o email, envie "email":"". O pedido deve conter pelo menos um campo permitido.

curl -i -X PATCH \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: customer-update-1042' \
  --data '{"email":"[email protected]"}' \
  "https://api-pay.edutecka.com/v1/customers/cus_..."