Skip to main content
GET
cURL

Escopo

O que são ciclos de cobrança?

Cada assinatura gera ciclos de cobrança periódicos. Um ciclo representa uma fatura com valor, vencimento, status e o histórico de tentativas de pagamento.

Visão histórica

Veja todos os ciclos de uma assinatura em ordem cronológica, do mais recente ao mais antigo.

Identifique inadimplência

Descubra se o cliente tem ciclos pendentes, atrasados ou com múltiplas tentativas de cobrança.

Acompanhe receita recorrente

Entenda se a assinatura está gerando receita de forma previsível ou se há interrupções.

Base para decisões

Use os dados de ciclo para decidir sobre retenção, cobrança manual ou cancelamento.

Quando usar cada endpoint


Casos de uso

Verifique se o cliente pagou todos os ciclos em dia ou se há atrasos recorrentes. Isso ajuda a identificar assinaturas em risco de cancelamento.
Um ciclo com status pendente e múltiplas tentativas pode indicar problema no cartão, limite insuficiente ou questão no gateway. Use os dados para tomar ação.
Analise a regularidade dos pagamentos ao longo dos ciclos para projetar a receita recorrente e identificar churn antes que aconteça.
Quando um cliente questiona uma cobrança, consulte o ciclo específico para verificar status, valor e tentativas de forma rápida e precisa.

Como interpretar a resposta

A resposta é uma lista paginada de ciclos. Cada ciclo contém:
Ciclos com status: paid e poucas tentativas indicam assinatura saudável. Ciclos com status: pending e muitas tentativas merecem atenção para retenção.
Os ciclos são retornados ordenados por data de vencimento decrescente. O primeiro item da lista é sempre o ciclo mais recente.

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

id
string<uuid>
required

Response

Corpo da resposta status 200

count
integer
required

Total de resultados

results
object[]
required

Lista de ciclos de cobrança

next
string<uri> | null

URL da próxima página

previous
string<uri> | null

URL da página anterior