id String (41 caracteres)
Id do cupom no formato COUP_UUID
.
Exemplo: COUP_8ADDC40F-17B0-4655-A124-4DEAEB2F5FDC
reference_id String
Código externo informado pelo merchant.
Exemplo: 123456
name String
Nome do cupom.
Exemplo: SandboxCoupon
description String
Descrição do cupom.
Exemplo: Sandbox Coupon
discount Object
Objeto contendo valor e tipo de desconto.
value Integer
Valor do desconto.
Exemplo: 10
type String
Tipo do desconto.
Valores possíveis: AMOUNT
, PERCENT
status String
Status do cupom.
Exemplo: ACTIVE
duration Object
Objeto contendo tipo de duração do cupom.
type String
Tipo de frequência do cupom.
Valores possíveis: ONCE
(uma vez), REPEATING
(repetir),
FOREVER
(válido até ser desativado).
redemption_limit Integer
Limite de resgates do cupom.
Exemplo: 10
exp_at Datetime
Data de expiração do cupom.
Exemplo: 2022-12-20
in_use Boolean
Indica se o cupom está em uso.
Exemplo: false
created_at Datetime
Data de criação do cupom.
Exemplo: 2022-10-25T15:21:21.091-03:00
updated_at Datetime
Data de última atualização do cupom.
Exemplo: 2022-10-25T15:21:21.091-03:00
links Array of objects
Lista de links referentes ao cupom.
rel String
Relação entre o link e o cupom.
Exemplo: SELF
href String
URL associada ao link.
Exemplo:
http://sandbox.api.assinaturas.pagseguro.com/coupons/COUP_8ADDC40F-17B0-4655-A124-4DEAEB2F5FDC
media String
Tipo de mídia associada ao link.
Exemplo: application/json
type String
Tipo de link.
Exemplo: GET