> ## 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. # Aplicar cupom na fatura > Aplica um código de cupom a uma fatura aberta e devolve a fatura com o desconto. ## OpenAPI ````yaml /api-reference/openapi.pt-BR.json post /pay/{slug}/invoices/{invoiceID}/coupon 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: /pay/{slug}/invoices/{invoiceID}/coupon: post: tags: - Checkout summary: Aplicar cupom na fatura description: > Aplica um código de cupom a uma fatura aberta e devolve a fatura com o desconto. operationId: applyCheckoutCoupon parameters: - name: slug in: path required: true schema: type: string description: O identificador público da sua conta, o mesmo das URLs de checkout. - name: invoiceID in: path required: true schema: type: string format: uuid description: ID da fatura. requestBody: required: true content: application/json: schema: type: object required: - code properties: code: type: string description: O código do cupom que o pagador digitou. responses: '200': content: application/json: schema: $ref: '#/components/schemas/Invoice' description: A fatura com o desconto aplicado. '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/ValidationFailed' security: [] components: schemas: Invoice: type: object properties: id: type: string format: uuid customerId: type: - string - 'null' format: uuid description: >- Id da inscrição do cliente no produto. Preenchido em faturas de produto, uso ou assinatura. payerId: type: - string - 'null' format: uuid description: Id do cliente que paga. Preenchido em faturas avulsas. subscriptionId: type: - string - 'null' format: uuid description: Assinatura que gerou a fatura invoiceNumber: type: - string - 'null' description: Número sequencial da fatura status: type: string enum: - draft - open - paid - void - uncollectible description: >- `draft` (em montagem), `open` (emitida, aguardando pagamento), `paid`, `void` (cancelada) ou `uncollectible` (dada como perdida). currency: type: string description: Moeda, em código ISO 4217 (`BRL`). subtotal: type: string description: Soma dos itens antes de impostos e descontos. tax: type: string description: Impostos da fatura. total: type: string description: Valor final da fatura. amountDue: type: string description: Quanto ainda falta pagar. periodStart: type: - string - 'null' format: date-time description: Início do período cobrado periodEnd: type: - string - 'null' format: date-time description: Fim do período cobrado dueDate: type: - string - 'null' format: date-time description: Data de vencimento. finalizedAt: type: - string - 'null' format: date-time description: Quando a fatura foi emitida. paidAt: type: - string - 'null' format: date-time description: Quando a fatura foi paga. successUrl: type: - string - 'null' description: Para onde o checkout leva o comprador depois do pagamento. cancelUrl: type: - string - 'null' description: Para onde o checkout leva o comprador se ele desistir. createdAt: type: string format: date-time lineItems: type: array items: $ref: '#/components/schemas/InvoiceLineItem' description: >- O que um cliente deve: itens, totais e status. Status: `draft` → `open` → `paid`, ou `void` / `uncollectible`. InvoiceLineItem: type: object properties: id: type: string format: uuid type: type: string enum: - usage - recurring - proration - credit - adjustment - commitment - manual description: >- `usage` (uso medido), `recurring` (mensalidade), `proration` (ajuste proporcional por troca no meio do período), `credit` (crédito), `adjustment` (uso que chegou depois de um período já faturado), `commitment` (diferença até o compromisso mínimo) ou `manual` (linha livre). meterId: type: - string - 'null' format: uuid description: Meter de onde veio o uso priceId: type: - string - 'null' format: uuid description: Preço aplicado a esta linha. description: type: string quantity: type: string description: Quantidade cobrada unitPrice: type: - string - 'null' description: Preço por unidade amount: type: string description: Total da linha proration: type: boolean description: '`true` quando a linha é um valor proporcional.' description: Uma linha da fatura. 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: BadRequest: content: application/json: schema: $ref: '#/components/schemas/Error' description: Requisição malformada. 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. ````