Documentation Index
Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt
Use this file to discover all available pages before exploring further.
Visão Geral
A Chargefy permite criar descontos que podem ser aplicados em checkouts para reduzir o valor da compra. Os descontos funcionam como cupons e podem ser do tipo fixo (valor em reais) ou percentual.Tipos de Desconto
Desconto Fixo
Reduz um valor absoluto do total da compra, em centavos.O valor de desconto fixo nunca ultrapassa o total da compra. Se o desconto for de R 30,00, o desconto aplicado será de R$ 30,00.
Desconto Percentual
Reduz uma porcentagem do total da compra, usando basis points (pontos base).Basis points: 100 basis points = 1%. Então 2500 = 25%, 1050 = 10.5%, 500 = 5%.
Duração do Desconto
Para assinaturas, você pode configurar por quanto tempo o desconto se aplica:| Duração | Comportamento |
|---|---|
once | Aplica apenas na primeira cobrança |
forever | Aplica em todas as cobranças futuras |
repeating | Aplica por um número definido de meses (duration_in_months) |
Limites de Uso
Você pode configurar limites para controlar quantas vezes um desconto pode ser utilizado:| Parâmetro | Descrição |
|---|---|
max_redemptions | Número máximo de vezes que o desconto pode ser usado |
starts_at | Data de início da validade |
ends_at | Data de fim da validade |
Validar e Resgatar
Validar Código
Antes de aplicar um desconto, valide o código para verificar se ainda é válido:- Se o código existe e não foi deletado
- Se está dentro do período de validade (
starts_at/ends_at) - Se não atingiu o limite máximo de usos (
max_redemptions)
Resgatar Desconto
O resgate é feito atomicamente para evitar condições de corrida:A operação de resgate utiliza uma função atômica no PostgreSQL para garantir que o limite de usos (
max_redemptions) seja respeitado mesmo com múltiplas requisições simultâneas.Aplicar no Checkout
Descontos podem ser aplicados durante a criação do checkout:Estatísticas
Consulte as estatísticas de uso de um desconto:Restrições de Edição
Após o primeiro uso de um desconto, alguns campos ficam bloqueados para edição:| Campo | Editável após uso? |
|---|---|
name | Sim |
code | Sim |
max_redemptions | Sim |
starts_at / ends_at | Sim |
type | Não |
amount / basis_points | Não |
duration | Não |
Escopos de API
| Escopo | Permissão |
|---|---|
discounts:read | Listar e visualizar descontos |
discounts:write | Criar, atualizar e deletar descontos |

