Eliminar Cliente

Elimina un cliente de tu organización. Esta operación no afecta las facturas ya emitidas a este cliente.

Endpoint

DELETE https://api.lummy.io/v1/customers/{customerId}

Entorno	URL
Producción	https://api.lummy.io/v1/customers/{customerId}
Sandbox	https://sandbox.lummy.io/v1/customers/{customerId}

Facturas existentes

Las facturas ya emitidas a este cliente no se verán afectadas. Solo se elimina el registro del cliente para futuras facturas.

---

Request

Headers

Headers requeridos

{

"Authorization": string,requerido

↳Token JWT obtenido del endpoint de autenticación o API Key. Debe incluir el prefijo "Bearer " seguido del token para autenticación JWT.

↳Ejemplo: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

"x-organization-id": stringrequerido

↳Identificador único de la organización a la que pertenece el cliente. Debe ser un UUID válido de una organización a la que el usuario autenticado tenga acceso.

↳Formato: UUID v4

↳Ejemplo: "550e8400-e29b-41d4-a716-446655440000"

}

Path Parameters

Parámetros de ruta

{

"customerId": stringrequerido

↳Identificador único del cliente que se desea eliminar. Debe ser un UUID válido de un cliente existente en la organización.

↳Formato: UUID v4

↳Ejemplo: "550e8400-e29b-41d4-a716-446655440000"

}

---

Response

204 No Content

Cliente eliminado exitosamente. No se retorna contenido en el body.

404 Not Found

El cliente especificado no existe en la organización.

{
  "requestId": "abc123-def456",
  "error": {
    "message": "Cliente no encontrado",
    "code": "CustomerNotFoundError",
    "status": 404
  },
  "timestamp": "2025-01-20T14:00:00.000Z",
  "path": "/customers/550e8400-e29b-41d4-a716-446655440000",
  "method": "DELETE"
}

---

Ejemplos de Código

cURL

curl -X DELETE https://sandbox.lummy.io/customers/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "x-organization-id: ${LUMMY_ORG_ID}"

Node.js (TypeScript)

import axios from 'axios';

async function eliminarCliente(customerId: string): Promise<void> {
  const API_URL = `https://sandbox.lummy.io/customers/${customerId}`;

  await axios.delete(API_URL, {
    headers: {
      'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
      'x-organization-id': process.env.LUMMY_ORG_ID!,
    },
  });

  console.log('Cliente eliminado exitosamente');
}

eliminarCliente('550e8400-e29b-41d4-a716-446655440000');

Python

import os
import requests

def eliminar_cliente(customer_id):
    api_url = f"https://sandbox.lummy.io/customers/{customer_id}"

    headers = {
        "Authorization": f"Bearer {os.getenv('ACCESS_TOKEN')}",
        "x-organization-id": os.getenv("LUMMY_ORG_ID"),
    }

    response = requests.delete(api_url, headers=headers)
    response.raise_for_status()

    print("Cliente eliminado exitosamente")

if __name__ == "__main__":
    eliminar_cliente("550e8400-e29b-41d4-a716-446655440000")

PHP (Guzzle)

<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

function eliminarCliente(string $customerId): void
{
    $client = new Client([
        'base_uri' => 'https://sandbox.lummy.io',
        'headers' => [
            'Authorization' => 'Bearer ' . getenv('ACCESS_TOKEN'),
            'x-organization-id' => getenv('LUMMY_ORG_ID'),
        ],
    ]);

    $client->delete("/customers/{$customerId}");

    echo "Cliente eliminado exitosamente\n";
}

eliminarCliente('550e8400-e29b-41d4-a716-446655440000');