Skip to main content
O objeto solicitacao de offboarding rastreia o ciclo de vida completo do processo de cancelamento de uma organizacao. Ele suporta tanto cancelamento imediato quanto fluxos de retencao, onde a organizacao entra em um periodo de carencia antes do cancelamento final.
​
offboardingRequestId
string
O identificador unico da solicitacao de offboarding (UUIDv7).
​
organizationId
string
O ID da organizacao (UUIDv7).
​
action
string
A acao de offboarding. Um de: CANCEL_NOW, START_RETENTION.
​
reason
string
O motivo principal do offboarding.
​
reasonDetail
string|null
Detalhe adicional sobre o motivo. Null se nao fornecido.
​
notes
string|null
Notas em texto livre. Null se nao fornecidas.
​
campaignMode
string|null
O modo de campanha aplicado durante a retencao. Um de: SUSPENDED, INACTIVE. Null quando a acao e CANCEL_NOW.
​
billingMode
string|null
O modo de billing aplicado durante a retencao. Um de: CHARGED, FREE. Null quando a acao e CANCEL_NOW.
​
billingBehavior
string|null
The billing behavior applied when billing mode is FREE. Null when billing mode is CHARGED or action is CANCEL_NOW.
​
retentionDeadline
string|null
O prazo de retencao (ISO 8601). After this date, the request is automatically cancelled. Null when action is CANCEL_NOW.
​
retentionResolution
string|null
The resolution of the retention process. One of: RETAINED, CHURNED, AUTO_EXPIRED. Null while in retention.
​
status
string
The offboarding request status. One of: IN_RETENTION, PENDING_CANCELLATION, RETAINED, CANCELLED.
​
requestedBy
string
The user ID (UUIDv7) who requested the offboarding.
​
requestedAt
string
Timestamp when the offboarding was requested (ISO 8601).
​
resolvedBy
string|null
The user ID (UUIDv7) who resolved the retention. Null if not yet resolved.
​
resolvedAt
string|null
Timestamp de quando a retencao foi resolvida (ISO 8601). Null se ainda nao resolvida.
​
cancelledBy
string|null
The user ID (UUIDv7) who finalized the cancellation. Null if not cancelled by a user.
​
cancelledBySystem
boolean|null
Whether the cancellation was triggered automatically by the system. Null if not yet cancelled.
​
cancelledReason
string|null
The reason provided when finalizing the cancellation. Null if not yet cancelled.
​
cancelledAt
string|null
Timestamp de quando o cancelamento foi finalizado (ISO 8601). Null se ainda nao cancelado.
​
cancellationDetails
object|null
Additional cancellation details. Null if not provided.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "offboardingRequestId": "019525fe-4b30-7cb6-beda-6e8f0a2c4d6a",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "action": "START_RETENTION",
  "reason": "HIGH_COST",
  "reasonDetail": "Valor acima do orcamento trimestral",
  "notes": null,
  "campaignMode": "SUSPENDED",
  "billingMode": "FREE",
  "billingBehavior": "keep_as_draft",
  "retentionDeadline": "2026-04-24T23:30:00.000Z",
  "retentionResolution": null,
  "status": "IN_RETENTION",
  "requestedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "requestedAt": "2026-03-25T23:30:00.000Z",
  "resolvedBy": null,
  "resolvedAt": null,
  "cancelledBy": null,
  "cancelledBySystem": null,
  "cancelledReason": null,
  "cancelledAt": null,
  "cancellationDetails": null,
  "createdAt": "2026-03-25T23:30:00.000Z",
  "updatedAt": "2026-03-25T23:30:00.000Z"
}