discount_code é o código que o comprador digita, como BLACK20. Ele aponta
para um discount, que guarda a regra econômica. Vários códigos podem apontar
para o mesmo desconto, cada um com validade, restrições de cliente, mínimo de
compra e limite próprios.
Quando usar Discount Code
Usediscount_code quando o desconto depende de uma ação do comprador ou de
uma campanha com código público. Ele é a camada de distribuição: controla o
texto digitável (code), quem pode usar, valor mínimo, expiração e limites de
resgate.
Use
discount sozinho quando o desconto é
aplicado diretamente pela sua integração, sem campo para o comprador digitar.
Data Object
string
Identificador do código de desconto. Usa o prefixo
dcode_*.string
Sempre
"discount_code".string
Código digitável pelo comprador.
string
Data de criação em ISO 8601.
string | null
Cliente específico que pode resgatar o código. Vem
null quando qualquer
cliente pode usar.string
ID do desconto associado (
disc_*).string | null
Data de expiração em ISO 8601. Vem
null quando não há expiração.boolean
true quando o código só pode ser usado por clientes sem atividade de
cobrança anterior.boolean
true quando o código pode ser usado em novas compras.boolean
true em produção; false em ambiente de teste.integer | null
Limite total de usos do código. Vem
null quando não há limite.integer | null
Limite de usos por cliente. Vem
null quando não há limite por cliente.object
Objeto livre para correlacionar o código com o seu sistema. Quando vazio,
retorna
{}.integer | null
Valor mínimo da compra, em centavos. Vem
null quando não há mínimo.string | null
Moeda do valor mínimo em código de 3 letras minúsculas, como
brl. Vem null
quando não há valor mínimo.integer
Quantidade de vezes em que o código já foi usado.
string | null
Data da última atualização em ISO 8601.
boolean
true quando o código está ativo, dentro da janela de validade, acima do
mínimo exigido e abaixo do limite de uso.