Skip to main content
Um voucher representa um saldo de credito concedido a uma organizacao, tipicamente usado para creditos de onboarding ou ofertas promocionais. Diferente de cupons (que descontam faturas individuais), vouchers sao um saldo armazenado que e consumido ao longo do tempo conforme cobracas ocorrem. Vouchers possuem datas de inicio e expiracao opcionais, e rastreiam o saldo restante automaticamente. Voce encontrara objetos de voucher ao visualizar o saldo de credito de uma organizacao.
​
voucherId
string
O identificador unico do voucher (UUIDv7).
​
organizationId
string
O ID da organizacao.
​
externalRef
string
A referencia externa do voucher.
​
name
string
O nome de exibicao do voucher.
​
amount
integer
O valor total do voucher em centavos.
​
currency
string
O codigo da moeda (ex.: BRL, USD).
​
effectiveAt
string|null
Timestamp de quando o voucher entra em vigor (ISO 8601).
​
expiresAt
string|null
Timestamp de quando o voucher expira (ISO 8601).
​
amountRedeemed
integer
O valor ja resgatado em centavos.
​
status
string
O status do voucher. Um de: PENDING, ACTIVE, DEPLETED, EXPIRED.
​
createdBy
string
O agente que criou o voucher.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedBy
string
O agente que atualizou o voucher por ultimo.
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "externalRef": "vch_1Oy2pL2eZvKYlo2C0vIqMZ8y",
  "name": "Onboarding Credit",
  "amount": 50000,
  "currency": "BRL",
  "effectiveAt": "2026-02-01T00:00:00.000Z",
  "expiresAt": "2026-08-01T00:00:00.000Z",
  "amountRedeemed": 12500,
  "status": "ACTIVE",
  "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "createdAt": "2026-01-20T10:00:00.000Z",
  "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "updatedAt": "2026-03-10T09:30:00.000Z"
}