Skip to main content
Cria um novo desconto que pode ser aplicado em checkouts e assinaturas.

​
Autenticação

Requer um token de acesso válido (CHARGEFY_ACCESS_TOKEN) no header Authorization.

​
Parâmetros do Body

ParâmetroTipoObrigatórioDescrição
namestringSimNome do desconto
typestringSimTipo: fixed ou percentage
amountintegerCondicionalValor fixo em centavos (obrigatório quando type: fixed)
basisPointsintegerCondicionalPercentual em basis points (obrigatório quando type: percentage, ex: 1000 = 10%)
durationstringSimDuração: once, repeating ou forever
durationInMonthsintegerCondicionalMeses de duração (obrigatório quando duration: repeating)
maxRedemptionsintegerNãoMáximo de utilizações (null = ilimitado)
codestringNãoCódigo do cupom
productIdsarrayNãoIDs dos produtos elegíveis

​
Campos da Resposta

Retorna o objeto completo do desconto criado.

​
Exemplo de Requisição

curl -X POST "https://api.chargefy.io/api/v1/discounts/" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Desconto de Lançamento",
    "type": "percentage",
    "basisPoints": 2000,
    "duration": "once",
    "maxRedemptions": 100,
    "code": "LAUNCH20"
  }'

​
Exemplo de Resposta

{
  "id": "disc_new456",
  "name": "Desconto de Lançamento",
  "type": "percentage",
  "basisPoints": 2000,
  "duration": "once",
  "maxRedemptions": 100,
  "redemptionsCount": 0,
  "code": "LAUNCH20",
  "createdAt": "2026-03-12T10:00:00Z"
}