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

# Buscar cliente

> Com o id de um cliente, devolve o cliente e todas as suas inscrições (`CustomerDetail`). Com o id de uma inscrição, devolve só a inscrição (`ProductCustomer`).




## OpenAPI

````yaml /api-reference/openapi.pt-BR.json get /customers/{customerID}
openapi: 3.1.0
info:
  title: Infi API
  version: 0.0.1
  description: >
    A API REST do Infi: catálogo, clientes, medição de uso, assinaturas,
    faturas,

    pagamentos e checkout.


    **Autenticação.** Envie a chave secreta em `Authorization: Bearer sk_test_…`

    (sandbox) ou `sk_live_…` (produção). O prefixo da chave decide o ambiente.
    As

    rotas de checkout (`/pay/*`) e `/public/*` não levam chave: rodam no
    navegador

    de quem paga.


    **Idempotência.** Toda requisição que altera dados exige o header

    `Idempotency-Key`. Uma repetição com a mesma chave devolve a resposta
    original

    em vez de executar de novo.


    **Valores.** Dinheiro e quantidades trafegam como texto decimal (`"150.00"`,

    `"0.0001"`), nunca como número de ponto flutuante.


    **Erros.** O corpo traz `error_code` (estável, use para decidir), `message`

    (para pessoas) e `tracer_id` (envie ao suporte). Erros de limite de
    requisições

    e de idempotência vêm aninhados em `error`, com `code` e `request_id`.
servers:
  - url: https://api-sandbox.beinfi.com
    description: Sandbox
  - url: https://api.beinfi.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Catálogo
  - name: Clientes
  - name: Medição de uso
  - name: Assinaturas
  - name: Faturas
  - name: Pagamentos
  - name: Checkout
  - name: Cupons
  - name: Cobrança
  - name: Conta
  - name: Webhooks
  - name: Conta de teste
  - name: Rail
  - name: Lojas
paths:
  /customers/{customerID}:
    parameters:
      - $ref: '#/components/parameters/CustomerID'
    get:
      tags:
        - Clientes
      summary: Buscar cliente
      description: >
        Com o id de um cliente, devolve o cliente e todas as suas inscrições
        (`CustomerDetail`). Com o id de uma inscrição, devolve só a inscrição
        (`ProductCustomer`).
      operationId: getCustomer
      responses:
        '200':
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/CustomerDetail'
                  - $ref: '#/components/schemas/ProductCustomer'
          description: O cliente ou a inscrição.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    CustomerID:
      name: customerID
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: ID do cliente.
  schemas:
    CustomerDetail:
      allOf:
        - $ref: '#/components/schemas/Customer'
        - type: object
          properties:
            enrollments:
              type: array
              items:
                $ref: '#/components/schemas/ProductCustomer'
      description: O cliente e todas as suas inscrições.
    ProductCustomer:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Id da inscrição. É este que as chamadas de cobrança e de uso
            esperam.
        customerId:
          type: string
          format: uuid
          description: Id do cliente. Não use nas chamadas de cobrança e de uso; use `id`.
        productId:
          type: string
          format: uuid
        externalId:
          type: string
          description: O id do cliente no seu sistema.
        name:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        taxId:
          type:
            - string
            - 'null'
          description: CPF ou CNPJ.
        pspRef:
          type:
            - string
            - 'null'
          description: Referência do cliente no meio de pagamento, quando existe.
        metadata:
          type: object
          additionalProperties: true
          description: Os dados livres enviados na inscrição.
        creditAlertSent:
          type: boolean
          description: Se o aviso de saldo baixo já foi enviado para esta inscrição.
        createdAt:
          type: string
          format: date-time
      description: >-
        Uma inscrição: este cliente neste produto. O `id` é o id da inscrição,
        que assinaturas, faturas, uso e saldos referenciam.
    Customer:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Id do cliente. Não é o id da inscrição.
        externalId:
          type: string
          description: O id deste cliente no seu sistema.
        name:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        taxId:
          type:
            - string
            - 'null'
          description: CPF ou CNPJ.
        phone:
          type:
            - string
            - 'null'
          description: >-
            Telefone de contato, em formato internacional só com dígitos e sem
            `+` (por exemplo `5511999999999`). Serve para contato e não
            identifica o cliente.
        pspRef:
          type:
            - string
            - 'null'
          description: Referência do cliente no meio de pagamento, quando existe.
        createdAt:
          type: string
          format: date-time
      description: Quem paga, no nível da sua conta. O `externalId` é único na conta.
    Error:
      type: object
      required:
        - message
        - error_code
        - tracer_id
      properties:
        message:
          type: string
          description: Frase legível para pessoas.
        error_code:
          $ref: '#/components/schemas/ErrorCode'
          description: Código estável do erro. Use-o para decidir o que fazer.
        tracer_id:
          type: string
          description: Identificador da requisição. Informe-o ao falar com o suporte.
      description: >-
        O corpo de erro padrão. É plano (sem o envelope `error`) e o
        identificador de rastreio é `tracer_id`.
    NotFoundError:
      type: object
      required:
        - message
        - error_code
        - tracer_id
        - resource
      properties:
        message:
          type: string
        error_code:
          $ref: '#/components/schemas/ErrorCode'
        tracer_id:
          type: string
        resource:
          type: string
    ErrorCode:
      type: string
      examples:
        - internal_error
        - validation_failed
        - bad_request
        - unauthorized
        - forbidden
        - not_found
        - conflict
        - rate_limited
      description: >-
        Código estável do erro. A lista não é fechada: além dos códigos
        genéricos, cada área tem os seus (`coupon_expired`,
        `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…).
        Um código que você não conhece deve ser tratado pelo status HTTP,
        mostrando `message`; não falhe ao ler a resposta.
  responses:
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Chave ausente ou inválida.
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFoundError'
      description: Recurso não encontrado.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave secreta da conta: `Authorization: Bearer sk_test_…` ou
        `sk_live_…`. Use só no servidor.

````