Skip to main content
Retorna as informações completas de um desconto pelo seu ID.

Autenticação

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

Parâmetros de Path

ParâmetroTipoObrigatórioDescrição
idstringSimID do desconto

Campos da Resposta

CampoTipoDescrição
idstringID do desconto
namestringNome do desconto
typestringTipo (fixed ou percentage)
amountintegerValor fixo em centavos
basisPointsintegerPercentual em basis points
durationstringDuração
maxRedemptionsintegerMáximo de utilizações
redemptionsCountintegerNúmero de utilizações
codestringCódigo do cupom
createdAtdatetimeData de criação

Exemplo de Requisição

curl -X GET "https://api.chargefy.io/api/v1/discounts/disc_abc123" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

Exemplo de Resposta

{
  "id": "disc_abc123",
  "name": "Desconto de Lançamento",
  "type": "percentage",
  "basisPoints": 2000,
  "duration": "once",
  "maxRedemptions": 100,
  "redemptionsCount": 23,
  "code": "LAUNCH20",
  "createdAt": "2026-02-01T10:00:00Z"
}