> ## Documentation Index
> Fetch the complete documentation index at: https://cakto-dece4a15.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

<ResponseField name="id" type="string">
  Identificador único da assinatura (UUID).
</ResponseField>

<ResponseField name="status" type="string">
  Status atual da assinatura. Valores possíveis: `active`, `canceled`.
</ResponseField>

<ResponseField name="current_period" type="number">
  Período atual da assinatura — número da cobrança vigente.
</ResponseField>

<ResponseField name="recurrence_period" type="number">
  Intervalo em dias entre as recorrências de pagamento.
</ResponseField>

<ResponseField name="quantity_recurrences" type="number">
  Número de recorrências programadas para a assinatura. O valor `-1` indica recorrência infinita (sem data de término).
</ResponseField>

<ResponseField name="trial_days" type="number">
  Número de dias de teste gratuitos oferecidos ao cliente.
</ResponseField>

<ResponseField name="max_retries" type="number">
  Número máximo de tentativas de cobrança em caso de falha no pagamento.
</ResponseField>

<ResponseField name="amount" type="string">
  Valor cobrado a cada período de recorrência.
</ResponseField>

<ResponseField name="retry_interval" type="number">
  Intervalo em dias entre tentativas de cobrança em caso de falha.
</ResponseField>

<ResponseField name="paid_payments_quantity" type="number">
  Quantidade total de pagamentos realizados com sucesso até o momento.
</ResponseField>

<ResponseField name="retention" type="string">
  Tempo de retenção do cliente na assinatura no formato `HH:MM:SS`. Disponível apenas em eventos de cancelamento.
</ResponseField>

<ResponseField name="paymentMethod" type="string">
  Método de pagamento da assinatura.
</ResponseField>

<ResponseField name="next_payment_date" type="string | null">
  Data da próxima cobrança programada. `null` quando a assinatura está cancelada.
</ResponseField>

<ResponseField name="canceledAt" type="string | null">
  Data e hora do cancelamento. `null` enquanto a assinatura está ativa.
</ResponseField>

<ResponseField name="orders" type="array">
  Lista de IDs de todos os pedidos vinculados a esta assinatura.
</ResponseField>

## Exemplo

```json theme={null}
{
  "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
  }
}
```