> ## 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.

# Inscrever cliente no produto

> Inscreve um cliente no produto, criando o cliente se ainda não existir. É a chamada recomendada para começar a cobrar alguém.
Idempotente por `externalId`: repetir com o mesmo `externalId` devolve a mesma inscrição, e os campos enviados atualizam o cliente (os omitidos são mantidos).
Guarde o `id` da resposta: é o id da inscrição, que assinaturas, faturas, uso e saldos esperam. O campo `customerId` da resposta é outro id (o do cliente) e não serve para essas chamadas.




## OpenAPI

````yaml /api-reference/openapi.pt-BR.json post /products/{productID}/customers
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:
  /products/{productID}/customers:
    parameters:
      - $ref: '#/components/parameters/ProductID'
    post:
      tags:
        - Clientes
      summary: Inscrever cliente no produto
      description: >
        Inscreve um cliente no produto, criando o cliente se ainda não existir.
        É a chamada recomendada para começar a cobrar alguém.

        Idempotente por `externalId`: repetir com o mesmo `externalId` devolve a
        mesma inscrição, e os campos enviados atualizam o cliente (os omitidos
        são mantidos).

        Guarde o `id` da resposta: é o id da inscrição, que assinaturas,
        faturas, uso e saldos esperam. O campo `customerId` da resposta é outro
        id (o do cliente) e não serve para essas chamadas.
      operationId: createCustomer
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductCustomer'
          description: Inscrição criada ou já existente.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
components:
  parameters:
    ProductID:
      name: productID
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: ID do produto.
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
      description: >-
        Chave única por operação (um UUID serve). Repetir com a mesma chave
        devolve a resposta original.
  schemas:
    CreateCustomerRequest:
      type: object
      required:
        - externalId
      properties:
        externalId:
          type: string
          description: >-
            O id deste cliente no seu sistema (por exemplo, o id do usuário no
            seu app). Obrigatório; repetir o mesmo valor devolve o mesmo
            cliente.
        name:
          type:
            - string
            - 'null'
          description: Nome do cliente.
        email:
          type:
            - string
            - 'null'
          description: E-mail do cliente.
        taxId:
          type:
            - string
            - 'null'
          description: CPF ou CNPJ.
        pspRef:
          type:
            - string
            - 'null'
          description: >-
            Referência do cliente no meio de pagamento, se você já tiver uma.
            Normalmente não é preciso enviar.
        metadata:
          type: object
          additionalProperties: true
          description: Dados livres seus, em JSON. Guardados na inscrição.
    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.
    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
    ValidationError:
      type: object
      required:
        - message
        - error_code
        - tracer_id
        - errors
      properties:
        message:
          type: string
        error_code:
          $ref: '#/components/schemas/ErrorCode'
        tracer_id:
          type: string
        errors:
          type: array
          items:
            type: object
            required:
              - field
              - value
              - constraint
              - description
            properties:
              field:
                type: string
              value:
                type: string
              constraint:
                type: string
              description:
                type: string
          description: >-
            Detalhe por campo (`field`, `description`). Sempre presente num
            `422`; pode vir vazio.
      description: >-
        Corpo de um `422`. Mesmo formato de `Error`, mais `errors[]` com o
        detalhe por campo. É ali que está a frase que diz o que corrigir (por
        exemplo, "product has no published version").
    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.
    ValidationFailed:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
      description: >-
        Um ou mais campos são inválidos. O detalhe de cada campo está em
        `errors[]`.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave secreta da conta: `Authorization: Bearer sk_test_…` ou
        `sk_live_…`. Use só no servidor.

````