Skip to main content
Um 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.

​
Data Object

{
  "id": "dcode_123",
  "object": "discount_code",
  "code": "BLACK20",
  "created_at": "2026-05-21T12:00:00Z",
  "customer": null,
  "discount": "disc_123",
  "expires_at": "2026-06-01T00:00:00Z",
  "first_time_transaction": false,
  "is_active": true,
  "livemode": true,
  "max_redemptions": 500,
  "max_redemptions_per_customer": null,
  "metadata": {},
  "minimum_amount": 10000,
  "minimum_amount_currency": "brl",
  "redemptions_count": 0,
  "updated_at": null,
  "valid": true
}
​
id
string
Identificador do código de desconto. Usa o prefixo dcode_*.
​
object
string
Sempre "discount_code".
​
code
string
Código digitável pelo comprador.
​
created_at
string
Data de criação em ISO 8601.
​
customer
string | null
Cliente específico que pode resgatar o código. Vem null quando qualquer cliente pode usar.
​
discount
string
ID do desconto associado (disc_*).
​
expires_at
string | null
Data de expiração em ISO 8601. Vem null quando não há expiração.
​
first_time_transaction
boolean
true quando o código só pode ser usado por clientes sem atividade de cobrança anterior.
​
is_active
boolean
true quando o código pode ser usado em novas compras.
​
livemode
boolean
true em produção; false em ambiente de teste.
​
max_redemptions
integer | null
Limite total de usos do código. Vem null quando não há limite.
​
max_redemptions_per_customer
integer | null
Limite de usos por cliente. Vem null quando não há limite por cliente.
​
metadata
object
Objeto livre para correlacionar o código com o seu sistema. Quando vazio, retorna {}.
​
minimum_amount
integer | null
Valor mínimo da compra, em centavos. Vem null quando não há mínimo.
​
minimum_amount_currency
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.
​
redemptions_count
integer
Quantidade de vezes em que o código já foi usado.
​
updated_at
string | null
Data da última atualização em ISO 8601.
​
valid
boolean
true quando o código está ativo, dentro da janela de validade, acima do mínimo exigido e abaixo do limite de uso.

​
Operações