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

# Criar link com produto

> Do zero a uma URL pagável numa chamada só. O produto é identificado pela `key`: uma chave nova cria o produto, uma conhecida reaproveita, e um preço diferente do atual publica uma nova versão. Links já compartilhados continuam vendendo o preço que anunciavam.

Cada chamada cria um link novo, então dá para ter uma URL por campanha. A resposta traz a `url` para mandar ao pagador; não precisa informar o slug da conta.




## OpenAPI

````yaml /api-reference/openapi.pt-BR.json post /payment-links
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:
  /payment-links:
    post:
      tags:
        - Catálogo
      summary: Criar link com produto
      description: >
        Do zero a uma URL pagável numa chamada só. O produto é identificado pela
        `key`: uma chave nova cria o produto, uma conhecida reaproveita, e um
        preço diferente do atual publica uma nova versão. Links já
        compartilhados continuam vendendo o preço que anunciavam.


        Cada chamada cria um link novo, então dá para ter uma URL por campanha.
        A resposta traz a `url` para mandar ao pagador; não precisa informar o
        slug da conta.
      operationId: createPaymentLinkWithProduct
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentLinkWithProductRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLink'
          description: Link criado.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: >-
            Definição de produto inválida: `key` ausente, um `billingCycle` que
            não combina com o `pricingModel`, ou falta um preço que o modelo
            exige.
      security:
        - BearerAuth: []
components:
  schemas:
    CreatePaymentLinkWithProductRequest:
      type: object
      required:
        - product
      properties:
        product:
          $ref: '#/components/schemas/InlineProductSpec'
          description: O produto, definido na própria chamada e identificado pela `key`.
        successUrl:
          type:
            - string
            - 'null'
          maxLength: 2048
          description: >-
            Para onde o pagador vai depois de pagar, com
            `?status=success&invoice=…` anexado. URL absoluta `http(s)`.
        cancelUrl:
          type:
            - string
            - 'null'
          maxLength: 2048
          description: >-
            Oferecido ao pagador como "voltar para a loja" enquanto o checkout
            está aberto. URL absoluta `http(s)`.
    PaymentLink:
      type: object
      properties:
        id:
          type: string
          format: uuid
        productId:
          type: string
          format: uuid
        token:
          type: string
          description: Token público do link, parte da `url`.
        url:
          type: string
          description: >-
            O endereço para mandar ao pagador. Use este valor em vez de montar a
            URL.
        productVersionId:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            A versão do produto que o link vende, fixada na criação. Publicar
            uma nova versão não altera o preço de um link já emitido. Quando
            `null`, o link vende a versão publicada mais recente no momento do
            pagamento.
        active:
          type: boolean
          description: '`false` depois de revogado.'
        revokedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Quando o link foi revogado.
        createdAt:
          type: string
          format: date-time
        successUrl:
          type:
            - string
            - 'null'
          description: >-
            Para onde o pagador vai depois de pagar, com
            `?status=success&invoice=…` anexado.
        cancelUrl:
          type:
            - string
            - 'null'
          description: >-
            Oferecido ao pagador como "voltar para a loja" enquanto o checkout
            está aberto; também é o destino com `?status=error` quando a
            cobrança expira no checkout embutido.
      description: >-
        Um link de pagamento reutilizável e revogável, ligado a um produto. Quem
        tem o link pode abrir o checkout; ele é feito para ser copiado e
        compartilhado.
    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").
    InlineProductSpec:
      type: object
      required:
        - key
        - pricingModel
      properties:
        key:
          type: string
          description: >-
            Chave estável do produto, única na sua conta. Obrigatória: é o que
            faz duas chamadas para o mesmo produto resultarem num produto só.
        name:
          type: string
          description: 'Nome exibido. Padrão: a `key`.'
        type:
          type: string
          enum:
            - agent
            - item
          description: '`item` (padrão) ou `agent`.'
        description:
          type:
            - string
            - 'null'
        pricingModel:
          type: string
          enum:
            - subscription
            - one_time
            - usage
            - prepaid
          description: '`subscription`, `one_time`, `usage` ou `prepaid`.'
        currency:
          type: string
          minLength: 3
          maxLength: 3
          description: 'Código ISO 4217 de 3 letras. Padrão: `BRL`.'
        billingCycle:
          type:
            - string
            - 'null'
          enum:
            - weekly
            - monthly
            - annual
            - null
          description: >-
            Obrigatório para `subscription` e `prepaid`; não envie nos outros
            modelos.
        basePrice:
          type:
            - string
            - 'null'
          description: Preço base em texto decimal (`"49.90"`).
        meters:
          type: array
          items:
            $ref: '#/components/schemas/InlineMeterSpec'
          description: >-
            Medidores do produto, criados uma vez pelo `name`. Um medidor que já
            existe não é alterado por esta chamada.
        prices:
          type: array
          items:
            $ref: '#/components/schemas/InlinePriceSpec'
          description: >-
            A lista completa de preços da versão. Uma lista diferente da versão
            atual publica uma nova versão. Omita o campo para não mexer nos
            preços; uma lista vazia significa "sem preços".
      description: >-
        Um produto definido na criação do link, identificado pela `key`. Uma
        chave nova cria o produto; uma conhecida reaproveita, e um preço
        diferente do atual publica uma nova versão. Links já em circulação
        continuam vendendo o que anunciavam.
    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`.
    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.
    InlineMeterSpec:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: Chave que você envia em `track()`. Não muda depois de criado.
        displayName:
          type: string
        unit:
          type: string
          enum:
            - token
            - request
            - unit
          description: '`token`, `request` ou `unit`.'
        aggregation:
          type: string
          enum:
            - sum
            - count
            - unique_count
            - max
            - last
          description: '`sum`, `count`, `unique_count`, `max` ou `last`.'
        valueProperty:
          type:
            - string
            - 'null'
          description: >-
            Campo do evento que carrega o valor numérico. Não é usado com
            `count`.
    InlinePriceSpec:
      type: object
      required:
        - meter
        - model
      properties:
        meter:
          type: string
          description: >-
            O `name` do medidor que este preço cobra. Obrigatório: um valor sem
            medidor é o `basePrice` do produto.
        model:
          type: string
          enum:
            - flat
            - per_unit
            - tiered
            - volume
            - package
          description: '`flat`, `per_unit`, `tiered`, `volume` ou `package`.'
        unitAmount:
          type:
            - string
            - 'null'
          description: Valor por unidade em texto decimal.
        tiers:
          type: object
          description: Faixas de preço para `tiered`, `volume` e `package`.
        currency:
          type: string
          minLength: 3
          maxLength: 3
          description: Opcional; padrão é a moeda do produto.
  responses:
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Chave ausente ou inválida.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave secreta da conta: `Authorization: Bearer sk_test_…` ou
        `sk_live_…`. Use só no servidor.

````