> ## Documentation Index > Fetch the complete documentation index at: https://userepass.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Lista os cupons > Lista os cupons da organização, com paginação por cursor. Permite filtrar por programa, afiliado e status. ## OpenAPI ````yaml /openapi.json get /coupons openapi: 3.1.0 info: title: Repass API description: >- API pública do Repass — plataforma de gestão de afiliados: programas, links, tracking, atribuição, conversões, comissões, payouts, fiscal (BR), reprocessamento, event store e webhooks. version: 0.1.0 servers: - url: https://api.userepass.com description: Produção security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: Profile description: Perfil do usuário autenticado. - name: Guide description: >- Guia de onboarding do painel: estado de tours, telas visitadas e preferências por usuário e organização. - name: Portal description: >- Portal do afiliado: sessão por identidade de afiliado (sem org), convites e claim. - name: Programs description: 'Programas de afiliados: configuração, atribuição, hold e tiers.' - name: Commission Rules description: Regras de comissão versionadas (imutáveis) por programa. - name: Affiliates description: 'Ciclo de vida do afiliado: cadastro, aprovação, tier, saldo.' - name: Terms description: Termos do programa, versionados. - name: Materials description: >- Materiais (criativos) do programa: upload pelo gestor e download pelos afiliados. - name: Links description: Links rastreáveis e domínios de redirecionamento. - name: Coupons description: Cupons de afiliado e sync com gateway. - name: Pagamentos por PIX description: Habilitação de pagamentos por PIX (onboarding e documentos). - name: Tracking description: Endpoints públicos de redirect e registro de cliques. - name: Clicks description: Consulta de cliques e estatísticas de link. - name: Conversions description: 'Conversões: ingestão S2S, atribuição, matching, fraude e auditoria.' - name: Commissions description: Comissões calculadas, holds, aprovação, void e clawback. - name: Payouts description: Ciclos de pagamento, prévia, execução e comprovantes. - name: Invoices description: Notas fiscais (PJ), envio e validação (BR). - name: Fraud description: Fila de revisão e decisões de fraude. - name: Reprocess description: Reprocessamento com dry-run obrigatório e relatório de impacto. - name: Events description: Histórico de eventos para auditoria e consulta. - name: Notifications description: >- Notificações ao operador (falhas de sincronização, payouts e afins) — registro in-app espelhado por e-mail aos owners/admins. - name: Webhooks description: Endpoints de webhook, entregas, retries e dead-letter. - name: Ingest description: Ingestão de eventos de cobrança (S2S e gateways). - name: Settings description: Configurações por organização (políticas e integrações). - name: Billing description: 'Plano e cobrança: contadores de uso da organização para o painel.' - name: Dashboard description: >- Métricas agregadas da operação (receita, top afiliados, conversões, comissões, novos afiliados) para a home e os relatórios do gestor. - name: Health description: Liveness do serviço. paths: /coupons: get: tags: - Coupons summary: Lista os cupons description: >- Lista os cupons da organização, com paginação por cursor. Permite filtrar por programa, afiliado e status. operationId: listCoupons parameters: - schema: default: 25 type: integer minimum: 1 maximum: 100 in: query name: limit required: false - schema: type: string pattern: ^coup_[0-9A-HJKMNP-TV-Z]{26}$ in: query name: starting_after required: false - schema: type: string pattern: ^coup_[0-9A-HJKMNP-TV-Z]{26}$ in: query name: ending_before required: false - schema: example: prog_01J9ZQ8H6K3M2N4P5R6S7T8U9V type: string in: query name: program_id required: false description: Filtra cupons por programa. - schema: example: aff_01J9ZQ8H6K3M2N4P5R6S7T8U9V type: string in: query name: affiliate_id required: false description: Filtra cupons por afiliado. - schema: type: string enum: - pending - active - sync_failed - inactive example: active in: query name: status required: false description: Filtra cupons por status. responses: '200': description: Default Response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: Identificador único do cupom (prefixo `coup_`). example: coup_01J9ZQ8H6K3M2N4P5R6S7T8U9V organizationId: type: string description: Organização dona do cupom. example: org_01J9ZQ8H6K3M2N4P5R6S7T8U9V programId: type: string description: Programa ao qual o cupom pertence. example: prog_01J9ZQ8H6K3M2N4P5R6S7T8U9V affiliateId: type: string description: Afiliado dono do cupom. example: aff_01J9ZQ8H6K3M2N4P5R6S7T8U9V code: type: string description: Código do cupom, normalizado em maiúsculas. example: MARIA15 discountType: type: string enum: - percentage - fixed description: >- Tipo de desconto. `percentage`: percentual sobre a compra. `fixed`: valor fixo em centavos. example: percentage discountValue: type: number description: >- Valor do desconto. Para `percentage`, é o percentual (ex.: 15 = 15%). Para `fixed`, é o valor fixo em centavos (ex.: 1990 = R$19,90). example: 15 status: type: string enum: - pending - active - sync_failed - inactive description: >- Status do cupom. `pending`: criado, aguardando sincronização com o provedor de pagamento. `active`: sincronizado e válido para uso. `sync_failed`: a sincronização com o provedor de pagamento falhou (tente novamente com a operação de ressincronização). `inactive`: desativado, não gera mais descontos. example: active providerSync: anyOf: - type: object properties: provider: type: string description: >- Identificador do provedor de pagamento usado na sincronização. example: stripe status: type: string enum: - synced - failed description: >- Resultado da última sincronização. `synced`: criado/atualizado no provedor de pagamento com sucesso. `failed`: a sincronização falhou. example: synced syncedAt: description: >- Data/hora (ISO-8601) da última sincronização bem-sucedida. example: '2026-06-13T12:00:00.000Z' type: string error: description: >- Mensagem de erro retornada pelo provedor de pagamento quando a sincronização falhou. type: string externalIds: description: >- IDs dos objetos criados no provedor de pagamento na última sincronização bem-sucedida. Usados internamente para propagar a desativação. type: object properties: couponId: description: >- ID do objeto de desconto criado no provedor de pagamento. example: 8bKvR2Yp type: string promotionCodeId: description: >- ID do código promocional criado no provedor de pagamento. example: promo_1PxYzABC123 type: string additionalProperties: false required: - provider - status additionalProperties: false - type: 'null' description: >- Status da sincronização com o provedor de pagamento. `null` enquanto a sincronização ainda não foi tentada. deactivatedAt: anyOf: - type: string format: date-time - type: 'null' description: >- Data/hora em que o cupom foi desativado. `null` se estiver ativo. example: '2026-06-13T12:00:00.000Z' createdAt: description: Data/hora de criação do cupom (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time updatedAt: description: Data/hora da última atualização do cupom (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time required: - id - organizationId - programId - affiliateId - code - discountType - discountValue - status - providerSync - deactivatedAt - createdAt - updatedAt additionalProperties: false hasMore: type: boolean nextCursor: anyOf: - type: string - type: 'null' description: Cursor da próxima página (use em starting_after). previousCursor: anyOf: - type: string - type: 'null' description: Cursor da página anterior (use em ending_before). required: - data - hasMore - nextCursor - previousCursor additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave de API (prefixo `rstr_`) enviada como `Authorization: Bearer rstr_...`. apiKeyAuth: type: apiKey in: header name: x-api-key description: Chave de API (prefixo `rstr_`) enviada no header `x-api-key`. ````