Estrutura

Uma cobrança é representada em nossa API pela seguinte estrutura:

{
  "id": "MY_COUPON",
  "discountKind": "PERCENTAGE",
  "discount": 10,
  "maxRedeems": -1,
  "redeemsCount": 0,
  "status": "ACTIVE",
  "devMode": true,
  "notes": "teste de cupom",
  "createdAt": "2025-01-23T14:06:16.880Z",
  "updatedAt": "2025-01-23T14:06:16.880Z"
}

Atributos

id string
Id único do seu cupom

notes string
Descrição sbre o cupom

maxRedeems number
Quantidade de vezes em que o cupom pode ser resgatado. -1 Significa que esse cupom pode ser resgatado sem limites

discountKind string
Tipo de desconto aplicado, porcentagem ou fixo. Pode ser FIXED ou PERCENTAGE

discount string
Valor do desconto a ser aplicado

status string
Status da cobrança. Pode ser PENDING, EXPIRED, CANCELLED, PAID, REFUNDED

Status	Descrição
`ACTIVE`	O cupom pode ser utilizado
`DELETED`	O cupom foi removido
`DISABLED`	O cupom foi desabilitado por você ou excedeu o limite de resgates

devMode boolean
Indica se a cobrança foi criada em dev mode ou não

metadata object

Objeto chave valor para metadados do cupom