Descontos
Criar um desconto
Cria uma regra econômica de desconto.
Cria um
discount. Para um cupom digitável pelo comprador, crie depois um
discount_code com discount_id.
Obrigatórios: name e type. O campo de valor depende do type —
exatamente um dos dois formatos: type=fixed exige amount_off + currency;
type=percentage exige percent_off_basis_points. Enviar o formato errado para
o type escolhido (ou nenhum) retorna 400. Todo o resto tem default.
Autenticação
A API key da própria organização atua diretamente. A API key de plataforma exige o headerOrganization: <organization_id> apontando para uma organização
conectada ativa.
Attributes
Valor fixo na menor unidade da moeda (centavos em
brl) (inteiro positivo). Obrigatório quando type=fixed;
só válido com type=fixed.O teto depende da moeda. Em brl, o máximo é 999999999 na menor unidade. Acima do teto, a API retorna 400 amount_too_large com param e maximum_amount. Quando o valor já está associado a uma moeda, a resposta inclui currency.Escopo do desconto. Use
products com IDs prod_*; array vazio (padrão)
aplica a todos os produtos. Todos os IDs precisam ser de produtos ativos da
organização — ID desconhecido ou de outra organização retorna 400. Quando
há produtos definidos, o abatimento é calculado somente sobre o subtotal das
linhas elegíveis.Moeda de
amount_off. Obrigatório quando type=fixed; só válido com
type=fixed.Aceita hoje: brl. Maiúsculas valem como minúsculas (BRL é lido como brl); outra moeda retorna 400 com code: "unsupported_currency". Veja Moedas.Número de meses (inteiro positivo). Obrigatório quando
duration=repeating;
para once e forever é ignorado e fica null.Data ISO 8601 de expiração. Padrão:
null (sem expiração). Precisa ser
posterior a starts_at quando ambos são enviados.Percentual em basis points, de 1 a 10000 (2000 = 20%). Obrigatório quando
type=percentage; só válido com type=percentage.Data ISO 8601 a partir da qual o desconto passa a valer. Padrão:
null
(vale imediatamente). Precisa ser anterior a expires_at quando ambos são
enviados — senão 400.O que a Chargefy resolve sozinha
durationnasceoncequando omitido.- O campo de valor do tipo não usado é zerado:
type=fixeddeixapercent_off_basis_pointscomonull;type=percentagedeixaamount_offecurrencycomonull. duration_in_monthsficanullquandodurationnão érepeating.is_activenascetrueeredemptions_countnasce0.currencyé normalizada para minúsculas.
Resposta
200 OK com o objeto discount completo.

