---
title: "GET /public_api/subscriptions/churn/"
method: GET
path: "/public_api/subscriptions/churn/"
tags: ["subscriptions"]
---

# GET /public_api/subscriptions/churn/

`GET /public_api/subscriptions/churn/`

Lista assinaturas canceladas e inativas com métricas agregadas

## Query parameters

- `limit` integer
- `offset` integer
- `status` string
- `current_period` integer
- `current_period__gt` integer
- `current_period__lt` integer
- `createdAt__gte` string, date-time
- `createdAt__lte` string, date-time
- `canceledAt__gte` string, date-time
- `canceledAt__lte` string, date-time

## Response `200`

Corpo da resposta status 200

- PaginatedSubscriptionChurnList
  - `count` integer, required — Total de resultados
  - `next` string, uri, nullable — URL da próxima página
  - `previous` string, uri, nullable — URL da página anterior
  - `results` SubscriptionChurn[], required
    - `id` string, required — Id da assinatura
    - `status` string, required — Status da assinatura (canceled ou inactive)
    - `current_period` integer — Período atual da assinatura
    - `recurrence_period` integer — Período de recorrência em dias
    - `quantity_recurrences` integer — Quantidade de recorrências
    - `trial_days` integer — Dias de teste
    - `max_retries` integer — Número máximo de retentativas
    - `amount` string, required — Valor da assinatura
    - `retry_interval` integer — Intervalo entre retentativas em dias
    - `paid_payments_quantity` integer — Quantidade de pagamentos efetuados
    - `retention` string — Tempo de retenção da assinatura
    - `paymentMethod` string — Método de pagamento
    - `customer` SubscriptionChurnCustomer, required
      - `name` string, required — Nome do cliente
    - `product` string — Id do produto
    - `offer` string — Id da oferta
    - `orders` string[] — Lista de IDs dos pedidos associados
    - `next_payment_date` string, date-time, nullable — Data do próximo pagamento
    - `canceledAt` string, date-time, nullable — Data de cancelamento
  - `metrics` SubscriptionChurnMetrics, required
    - `at_risk_value` number, float, required — Valor total das assinaturas inativas
    - `at_risk_count` integer, required — Quantidade de assinaturas inativas
    - `churned_value` number, float, required — Valor total das assinaturas canceladas
    - `churned_count` integer, required — Quantidade de assinaturas canceladas
    - `affected_customers_count` integer, required — Número de clientes únicos afetados
    - `total_at_risk_value` number, float, required — Soma do valor inativo + cancelado

## Other responses

- `401` — Request não autenticado devido à ausência ou invalidez do token.
- `403` — Permissão negada. O token não possui o escopo `subscriptions`.

---

[API](https://skmtc.net/cakto/apis/cakto-api.md) · [All operations](https://skmtc.net/cakto/apis/cakto-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cakto/cakto-api/versions/cba77b0560b5/schema)