Campos de Assinatura

Referência dos campos presentes no objeto subscription em eventos de pagamento recorrente.

O objeto subscription está presente nos eventos de produtos do tipo subscription e contém informações detalhadas sobre o ciclo da assinatura.

Campos

id · string

Identificador único da assinatura (UUID).

status · string

Status atual da assinatura. Valores possíveis: active, canceled.

current_period · number

Período atual da assinatura — número da cobrança vigente.

recurrence_period · number

Intervalo em dias entre as recorrências de pagamento.

quantity_recurrences · number

Número de recorrências programadas para a assinatura. O valor -1 indica recorrência infinita (sem data de término).

trial_days · number

Número de dias de teste gratuitos oferecidos ao cliente.

max_retries · number

Número máximo de tentativas de cobrança em caso de falha no pagamento.

amount · string

Valor cobrado a cada período de recorrência.

retry_interval · number

Intervalo em dias entre tentativas de cobrança em caso de falha.

paid_payments_quantity · number

Quantidade total de pagamentos realizados com sucesso até o momento.

retention · string

Tempo de retenção do cliente na assinatura no formato HH:MM:SS. Disponível apenas em eventos de cancelamento.

paymentMethod · string

Método de pagamento da assinatura.

next_payment_date · string | null

Data da próxima cobrança programada. null quando a assinatura está cancelada.

canceledAt · string | null

Data e hora do cancelamento. null enquanto a assinatura está ativa.

orders · array

Lista de IDs de todos os pedidos vinculados a esta assinatura.

Exemplo

{
  "subscription": {
    "id": "d464132a-fcfa-4693-a6aa-a99483f06740",
    "status": "active",
    "current_period": 8,
    "recurrence_period": 2,
    "quantity_recurrences": -1,
    "trial_days": 0,
    "max_retries": 2,
    "amount": "5.00",
    "retry_interval": 2,
    "paid_payments_quantity": 8,
    "paymentMethod": "credit_card",
    "next_payment_date": "2025-04-08T14:43:39.724743-03:00",
    "createdAt": "2025-04-08T14:41:42.247628-03:00",
    "canceledAt": null
  }
}