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

# Excluir um cliente

> Operação sobre clientes da conta.

Exclui o cadastro quando os vínculos existentes permitem. Esta operação não estorna pagamentos nem cancela assinaturas.

Requer `customers:write` ou `write`. Veja [campos, relacionamentos e eventos](https://docs.hubfy.io/api-reference/customers/object.md).


## OpenAPI

````yaml api/v1/openapi.yaml DELETE /v1/customers/{id}
openapi: 3.1.0
info:
  title: Hubfy API
  version: 1.0.0
  description: >-
    API pública da Hubfy para produtos, preços, arquivos, clientes, pedidos e
    links de pagamento. Autenticação por chave da conta. GET consulta; POST
    cria, atualiza ou executa ações; DELETE remove ou desativa. O ambiente usa
    dados reais, sem sandbox separado. Consulte os fundamentos, os objetos e os
    eventos em https://docs.hubfy.io/api-reference/introduction.
servers:
  - url: https://api.hubfy.io
security:
  - apiKeyAuth: []
tags:
  - name: Produtos
    description: Objeto Product. Campos e relacionamentos na visão geral.
  - name: Preços
    description: Objeto Price. Campos e relacionamentos na visão geral.
  - name: Arquivos
    description: Objeto Asset. Campos e relacionamentos na visão geral.
  - name: Clientes
    description: Objeto Customer. Campos e relacionamentos na visão geral.
  - name: Pedidos
    description: Objeto Order. Campos e relacionamentos na visão geral.
  - name: Links de pagamento
    description: Objeto PaymentLink. Campos e relacionamentos na visão geral.
  - name: Fundamentos da API
    description: Conexão e identificação da API.
paths:
  /v1/customers/{id}:
    delete:
      tags:
        - Clientes
      summary: Excluir um cliente
      description: >-
        Na criação, envie `email` e `name`, ambos não vazios. O email é
        convertido para minúsculas. Se já existir um cliente com esse email na
        conta, a criação retorna esse cadastro e preenche somente valores
        ausentes; não sobrescreve os dados existentes. Para alterar valores
        preenchidos, use a atualização.


        A atualização aceita os dados de contato, identificação, preferências,
        `external_id` e `metadata`. Os indicadores financeiros e `currency` são
        somente leitura. Excluir um cliente não é uma operação de estorno ou
        cancelamento; vínculos que impeçam a remoção retornam erro.


        Permissão: `customers:write` ou `write`. Consulte a [visão
        geral](/api-reference/customers/object) para campos e relacionamentos.
      operationId: deleteCustomer
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^cus_[a-z0-9]{16}$
          description: ID público do cliente na conta.
      responses:
        '200':
          description: Operação concluída
          headers:
            X-Request-Id:
              description: Identifier of this HTTP request
              schema:
                type: string
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Customer'
                  - $ref: '#/components/schemas/Deleted'
              example:
                id: cus_1234567890abcdef
                deleted: true
                object: customer
        '400':
          $ref: '#/components/responses/ApiFailure'
        '401':
          $ref: '#/components/responses/ApiFailure'
        '403':
          $ref: '#/components/responses/ApiFailure'
        '404':
          $ref: '#/components/responses/ApiFailure'
        '409':
          $ref: '#/components/responses/ApiFailure'
        '429':
          $ref: '#/components/responses/ApiFailure'
        '500':
          $ref: '#/components/responses/ApiFailure'
        '502':
          $ref: '#/components/responses/ApiFailure'
        '503':
          $ref: '#/components/responses/ApiFailure'
      security:
        - apiKeyAuth: []
components:
  schemas:
    Customer:
      type: object
      additionalProperties: false
      required:
        - id
        - city
        - country
        - created_at
        - currency
        - document
        - document_type
        - email
        - email_marketing_status
        - external_id
        - first_name
        - last_name
        - metadata
        - mrr_cents
        - name
        - object
        - phone
        - region
        - total_revenue_cents
        - updated_at
      properties:
        id:
          type: string
          pattern: ^cus_[a-z0-9]{16}$
          description: >-
            Identificador público estável. Use o valor retornado pela API nas
            consultas e relacionamentos; não derive IDs de nomes.
        city:
          type:
            - string
            - 'null'
          description: Cidade do cliente; null quando ausente.
        country:
          type:
            - string
            - 'null'
          description: País informado no cadastro; null quando ausente.
        created_at:
          type: string
          format: date-time
          description: >-
            Data e hora da criação, em ISO 8601 com fuso horário. Somente
            leitura.
        currency:
          type:
            - string
            - 'null'
          description: Moeda dos indicadores do cliente. Pode ser null. Somente leitura.
        document:
          type:
            - string
            - 'null'
          description: >-
            Documento do cliente como string, preservando zeros à esquerda; null
            quando ausente.
        document_type:
          type:
            - string
            - 'null'
          description: Tipo do documento informado, como cpf ou cnpj; null quando ausente.
        email:
          type:
            - string
            - 'null'
          description: >-
            Email do cliente. Obrigatório e não vazio na criação; convertido
            para minúsculas ao criar.
        email_marketing_status:
          type:
            - string
            - 'null'
          description: >-
            Situação de email marketing: subscribed, unsubscribed, archived,
            requires_verification, invalid_email ou bounced.
        external_id:
          type:
            - string
            - 'null'
          description: >-
            Identificador do cliente no seu sistema. Pode ser null. Não
            substitui o id da Hubfy.
        first_name:
          type:
            - string
            - 'null'
          description: Primeiro nome; null quando ausente.
        last_name:
          type:
            - string
            - 'null'
          description: Sobrenome; null quando ausente.
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Objeto JSON livre para referências da integração, limitado a 16 KB.
            Ao enviar, substitui todo o metadata anterior; use {} para limpar.
            Não aceita null.
        mrr_cents:
          type: integer
          description: >-
            Receita recorrente mensal registrada para o cliente, em centavos.
            Somente leitura.
        name:
          type:
            - string
            - 'null'
          description: Nome do cliente. Obrigatório e não vazio na criação.
        object:
          const: customer
          type: string
          description: Tipo do objeto retornado. O valor é fixo para este recurso.
        phone:
          type:
            - string
            - 'null'
          description: Telefone do cliente como string; null quando ausente.
        region:
          type:
            - string
            - 'null'
          description: Estado ou região do cliente; null quando ausente.
        total_revenue_cents:
          type: integer
          description: >-
            Receita acumulada registrada para o cliente, em centavos. Não deve
            ser enviada em criação ou atualização.
        updated_at:
          type: string
          format: date-time
          description: >-
            Data e hora da última alteração, em ISO 8601 com fuso horário.
            Somente leitura.
      example:
        id: cus_1234567890abcdef
        city: null
        country: null
        created_at: '2030-01-01T00:00:00.000Z'
        currency: BRL
        document: null
        document_type: null
        email: cliente@example.com
        email_marketing_status: subscribed
        external_id: null
        first_name: null
        last_name: null
        metadata: {}
        mrr_cents: 0
        name: Cliente Exemplo
        object: customer
        phone: null
        region: null
        total_revenue_cents: 0
        updated_at: '2030-01-01T00:00:00.000Z'
    Deleted:
      type: object
      additionalProperties: false
      required:
        - id
        - deleted
        - object
      properties:
        id:
          type: string
        deleted:
          type: boolean
          const: true
        object:
          type: string
          enum:
            - product
            - price
            - asset
            - customer
            - payment_link
      example:
        id: pro_1234567890abcdef
        deleted: true
        object: product
    ApiError:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - doc_url
            - message
            - param
            - type
          properties:
            code:
              type: string
            doc_url:
              type:
                - string
                - 'null'
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - api_error
      example:
        error:
          code: invalid_parameter
          doc_url: null
          message: The request contains invalid parameters
          param: null
          type: invalid_request_error
  responses:
    ApiFailure:
      description: A operação não foi concluída
      headers:
        X-Request-Id:
          description: Identifier of this HTTP request
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: invalid_parameter
              doc_url: null
              message: The request contains invalid parameters
              param: null
              type: invalid_request_error
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.