Skip to main content
The coupon object represents a reusable discount code that can be applied to subscriptions. Coupons support both fixed-amount and percentage discounts, with configurable duration, redemption limits, and expiration dates.
​
couponId
string
O identificador unico do cupom (UUIDv7).
​
externalRef
string
The external reference for the coupon.
​
code
string
The coupon code used for redemption.
​
name
string
O nome de exibicao do cupom.
​
type
string
O tipo de desconto. One of: FIXED, PERCENTAGE.
​
amount
integer
O valor do desconto. For FIXED type, the value in cents. For PERCENTAGE type, the percentage value.
​
currency
string
O codigo da moeda (ex: BRL, USD).
​
duration
string
How long the discount applies. One of: ONCE, REPEATING.
​
durationInMonths
integer|null
The number of months the discount applies when duration is REPEATING.
​
maxRedemptions
integer|null
The maximum number of times this coupon can be redeemed. Null for unlimited.
​
redeemBy
string|null
The deadline for redeeming this coupon (ISO 8601). Null if no deadline.
​
timesRedeemed
integer
O numero de vezes que este cupom foi resgatado.
​
amountRedeemed
integer
The total amount redeemed so far.
​
status
string
O status do cupom. One of: ACTIVE, DEPLETED, EXPIRED.
​
createdBy
string
The actor who created the coupon.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedBy
string
The actor who last updated the coupon.
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
​
deletedBy
string
The actor who deleted the coupon.
​
deletedAt
string
Deletion timestamp (ISO 8601).
{
  "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
  "externalRef": null,
  "code": "WELCOME20",
  "name": "Welcome Discount",
  "type": "PERCENTAGE",
  "amount": 20,
  "currency": "BRL",
  "duration": "REPEATING",
  "durationInMonths": 3,
  "maxRedemptions": 100,
  "redeemBy": "2026-12-31T23:59:59.000Z",
  "timesRedeemed": 42,
  "amountRedeemed": 0,
  "status": "ACTIVE",
  "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "createdAt": "2026-01-10T08:00:00.000Z",
  "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "updatedAt": "2026-03-15T16:45:00.000Z",
  "deletedBy": null,
  "deletedAt": null
}