> ## 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 cupom > Cria um cupom de desconto percentual. O comprador digita o `code` no checkout para aplicá-lo à fatura. ## OpenAPI ````yaml /api-reference/openapi.pt-BR.json post /billing/coupons 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: /billing/coupons: post: tags: - Cupons summary: Criar cupom description: > Cria um cupom de desconto percentual. O comprador digita o `code` no checkout para aplicá-lo à fatura. operationId: createCoupon requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCouponRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Coupon' description: Criado. '401': $ref: '#/components/responses/Unauthorized' '422': $ref: '#/components/responses/ValidationFailed' components: schemas: CreateCouponRequest: type: object required: - code - percentOff - duration properties: code: type: string description: >- Código do cupom: de 3 a 32 caracteres entre letras maiúsculas, números, `_` e `-` (ex.: `BLACKFRIDAY-20`). percentOff: type: string description: Percentual de desconto, em texto decimal, maior que 0 e até 100. duration: type: string enum: - once - repeating - forever description: >- `once` (só na primeira fatura), `repeating` (durante `durationInCycles` ciclos) ou `forever` (em todas as faturas). durationInCycles: type: - integer - 'null' description: >- Obrigatório (1 ou mais) quando `duration` é `repeating`; omita nos demais casos. maxRedemptions: type: - integer - 'null' description: Limite total de usos. Omita para não limitar. redeemBy: type: - string - 'null' format: date-time description: Prazo final para aplicar o cupom. Omita para não ter prazo. description: Dados de um novo cupom. Coupon: type: object required: - id - code - percentOff - duration - timesRedeemed - status - createdAt - updatedAt properties: id: type: string format: uuid code: type: string description: O código que o comprador digita no checkout. percentOff: type: string description: Percentual de desconto, em texto decimal (`"15"` = 15%). duration: type: string enum: - once - repeating - forever description: >- `once` (só na primeira fatura), `repeating` (durante `durationInCycles` ciclos) ou `forever` (em todas as faturas). durationInCycles: type: - integer - 'null' description: Quantos ciclos o desconto vale. Só em cupons `repeating`. maxRedemptions: type: - integer - 'null' description: Quantas vezes o cupom pode ser usado no total. `null` = sem limite. timesRedeemed: type: integer description: Quantas vezes o cupom já foi usado. redeemBy: type: - string - 'null' format: date-time description: Até quando o cupom pode ser aplicado. `null` = sem prazo. status: type: string enum: - active - archived description: '`active` (aceito no checkout) ou `archived` (não aceito mais).' createdAt: type: string format: date-time updatedAt: type: string format: date-time description: >- Um desconto percentual que o comprador aplica no checkout com o `code`. Em assinaturas, `duration` define por quantos ciclos o desconto vale. 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`. 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. 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. ````