> ## Documentation Index > Fetch the complete documentation index at: https://docs.pay.v4companyamaral.com/llms.txt > Use this file to discover all available pages before exploring further. # Atualizar cupom > Atualiza apenas os campos enviados no corpo da requisição. ## OpenAPI ````yaml /openapi.yaml put /coupons/{id} openapi: 3.1.0 info: title: V4Pay API version: 2.0.0 description: > API do gateway de pagamentos V4Pay: autenticação, clientes, cobranças, cupons e emissão de Pix — cada lojista tem uma conta de recebimento no CNPJ dele, e a cobrança leva um split com a taxa do V4 Pay. Todas as rotas protegidas usam token JWT — o usuário é identificado pelo token, nunca por `user_id` no corpo da requisição. servers: - url: https://v4pay-api.vercel.app description: Produção. - url: http://localhost:3000 description: Ambiente local de desenvolvimento. security: [] tags: - name: Pix description: Emitir e consultar cobranças Pix — o coração da API. - name: Cobranças description: Registro direto de cobranças e a listagem do histórico da loja. - name: Clientes description: Cadastro de pagadores para reutilizar nas cobranças. - name: Links de pagamento description: URLs públicas reutilizáveis que abrem o checkout com o valor definido. - name: Checkout (público) description: >- As rotas que a página de pagamento usa — sem autenticação, o pagador não tem conta. - name: Produtos description: Catálogo da loja; um produto pode virar cobrança ou link. - name: Cupons description: Descontos aplicados no checkout e na emissão por produto. - name: Assinaturas description: Cobrança recorrente, gerada por um cron diário. - name: Webhooks (endpoints) description: >- As URLs do seu servidor que recebem os eventos da loja, com assinatura HMAC. - name: Chaves de API description: Credenciais de integração (v4pay_test_ / v4pay_live_), revogáveis. - name: Conta de recebimento description: Cadastro da empresa e a conta que recebe — vale no modo subconta. - name: Aprovação de produção description: >- O fluxo para liberar a operação em produção — dados da empresa, documentos e análise da equipe. - name: Saques description: >- Pedidos de saque do saldo — suspensos no modo conta única (REPASSE_MANUAL). - name: Membros da loja description: Convites e papéis de quem opera a loja junto com o dono. - name: Conta (auth) description: Cadastro, login, perfil e a troca de ambiente da sessão. - name: Auditoria description: Trilha das ações feitas na loja, com quem fez e de onde. - name: Sistema description: Saúde da API. - name: Interno description: >- USO INTERNO DO PAINEL — documentado por transparência, não para integração: pode mudar sem aviso (Roadmap, aprovações da equipe, cron, login com Google, onboarding). paths: /coupons/{id}: put: tags: - Cupons summary: Atualizar cupom description: Atualiza apenas os campos enviados no corpo da requisição. parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CouponRequest' responses: '200': description: Cupom atualizado com sucesso. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Coupon' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' security: - bearerAuth: [] components: schemas: CouponRequest: type: object description: Dados para criação de um cupom de desconto. required: - code - type - value properties: code: type: string description: Código do cupom. example: BEMVINDO10 type: type: string description: Tipo do desconto (ex. percentual ou valor fixo). example: percent value: type: number format: double description: Valor do desconto (percentual ou em reais, conforme o tipo). example: 10 description: type: string example: Cupom de boas-vindas max_uses: type: integer description: Número máximo de utilizações do cupom. example: 100 expires_at: type: string format: date-time example: '2026-12-31T23:59:59Z' is_active: type: boolean description: >- `false` desativa o cupom: ele é recusado no checkout e no /coupons/validate, sem apagar o histórico. É a alternativa à exclusão quando o cupom tem referências demais (ver o `409` do DELETE). Só tem efeito na atualização (`PUT`); na criação todo cupom nasce ativo. example: false Coupon: type: object description: Objeto representando um cupom de desconto. properties: id: type: string format: uuid user_id: type: string format: uuid code: type: string example: BEMVINDO10 type: type: string example: percent value: type: number format: double example: 10 description: type: string max_uses: type: integer example: 100 used_count: type: integer description: Quantidade de vezes que o cupom já foi resgatado. example: 12 expires_at: type: string format: date-time created_at: type: string format: date-time Error: type: object properties: error: type: object properties: message: type: string description: Descrição da mensagem de erro. ErrorAuth: type: object description: > Segundo formato de erro, usado só pelo middleware de autenticação (token ausente, inválido ou chave revogada). Repare que aqui `error` é uma string, não um objeto. properties: error: type: string example: Token JWT ou chave de API ausente responses: BadRequest: description: Erro de validação nos dados enviados. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Não autenticado. Repare no formato — `error` é string neste caso. content: application/json: schema: $ref: '#/components/schemas/ErrorAuth' NotFound: description: O recurso solicitado não foi encontrado. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Token JWT obtido em `/auth/login`, enviado no cabeçalho `Authorization` no formato `Bearer `. ````