API · Assinaturas

Consultar assinatura

GET /api/crypto/v1/subscriptions/{id} — estado e ciclo atual.

GET /api/crypto/v1/subscriptions/{id}

Autentique com X-Manage-Token, usando o token retornado na criação. O backend também aceita manageToken na query, mas prefira o cabeçalho para evitar exposição em histórico e logs.

curl 'https://api.caedral.com/api/crypto/v1/subscriptions/ID_DA_ASSINATURA' \
  -H 'X-Manage-Token: SEU_MANAGE_TOKEN'

200 retorna subscriptionId, status, customerRef, amountBRL, intervalDays, token, mode, dados opcionais de autorização, chain, cycle, currentCharge, nextChargeAt e createdAt. currentCharge pode ser nulo e, quando presente, contém ref, status, cryptoAmount, paymentUrl e expiresAt.

Os estados de assinatura são active, paused, canceled e past_due. 404 indica assinatura não encontrada ou token inválido; 500 indica erro interno, inclusive possível ID malformado.

Exemplo de resposta 200

Os valores são ilustrativos e variam conforme o ambiente e a ordem.

{
  "subscriptionId": "674000000000000000000001",
  "status": "active",
  "customerRef": "cliente_1042",
  "amountBRL": 49.9,
  "intervalDays": 30,
  "token": "USDC",
  "mode": "invoice",
  "customerAddress": null,
  "onchainSubId": null,
  "authorizedAt": null,
  "chain": "base",
  "cycle": 1,
  "currentCharge": {
    "ref": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "status": "pending",
    "cryptoAmount": "9.330000",
    "paymentUrl": "https://pay.example/pay/0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "expiresAt": "2026-11-08T18:15:00.000Z"
  },
  "nextChargeAt": "2026-12-08T18:00:00.000Z",
  "createdAt": "2026-11-08T18:00:00.000Z"
}