Skip to main content
GET
/
public_api
/
subscriptions
/
{id}
/
billing-cycles
/
{cycle_id}
/
attempts
/
cURL
curl --request GET \
  --url https://api.cakto.com.br/public_api/subscriptions/{id}/billing-cycles/{cycle_id}/attempts/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "d9abeb29-6c7d-46fa-938a-4fbce40be05d",
      "attempt_number": 1,
      "amount": "100.00",
      "result": "failure",
      "failure_reason": "Insufficient funds",
      "scheduled_for": "2026-05-18T19:14:17.677041Z",
      "started_at": "2026-05-18T19:14:18.123456Z",
      "completed_at": "2026-05-18T19:14:20.789012Z",
      "created_at": "2026-05-18T19:14:17.677041Z"
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "attempt_number": 2,
      "amount": "100.00",
      "result": "success",
      "failure_reason": null,
      "scheduled_for": "2026-05-19T19:14:17.677041Z",
      "started_at": "2026-05-19T19:14:18.000000Z",
      "completed_at": "2026-05-19T19:14:22.000000Z",
      "created_at": "2026-05-18T19:14:17.677041Z"
    }
  ]
}

​
Escopo

    read subscriptions

​
Quando usar

  • Para entender por que uma cobrança específica falhou
  • Para verificar se o gateway está tentando cobrar novamente
  • Para decidir se é hora de entrar em contato com o cliente

​
Como interpretar as tentativas

As tentativas são retornadas ordenadas pelo número da tentativa:
CampoDescriçãoComo usar
attempt_numberSequência da tentativaVeja quantas vezes o sistema já tentou cobrar
resultsuccess ou failureIdentifique se alguma tentativa foi bem-sucedida
failure_reasonMotivo da recusaUse para entender o problema (ex: fundos insuficientes)
scheduled_forData agendadaVeja quando a próxima tentativa estava prevista
started_at / completed_atInício e fimMeça o tempo de processamento de cada tentativa
Múltiplas falhas seguidas com o mesmo failure_reason indicam um problema persistente no método de pagamento. Considere notificar o cliente antes do cancelamento automático.
Cada tentativa representa uma chamada real ao gateway de pagamento. Use este endpoint para auditar a integridade do processo de cobrança recorrente.

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

ID da assinatura

​
cycle_id
string<uuid>
required

ID do ciclo de cobrança

Response

Corpo da resposta status 200

​
count
integer
required

Total de resultados

​
results
object[]
required

Lista de tentativas de cobrança

​
next
string<uri> | null

URL da próxima página

​
previous
string<uri> | null

URL da página anterior