Skip to main content
GET
Recuperar detalhes de um cycle específico

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Path Parameters

id
string<uuid>
required

Id da assinatura

cycleId
string<uuid>
required

Id do ciclo

Response

Success

id
string<uuid>

Identificador do ciclo

Example:

"01985cf8-9877-7c09-bbf6-2cceb3384a61"

customerId
string<uuid>

Identificador do cliente

Example:

"2a8b64ce-904c-4256-b79a-49525808609c"

merchantId
string<uuid>

Identificador do merchant

Example:

"225d39bc-1fbb-480a-90bd-f0caad05d2d0"

cycle
integer

Número do ciclo

Example:

1

attempts
integer

Quantidade de tentativas de cobrança já feitas no ciclo. Não vem antes da primeira tentativa

Example:

1

status
enum<string>

Status do ciclo

Available options:
scheduled,
pending,
authorized,
failed,
retrying,
canceled
Example:

"authorized"

amount
integer

Valor do ciclo em centavos

Example:

29900

items
object[]

Itens cobrados no ciclo, no formato de items da assinatura. Campos opcionais sem valor vêm como null. Só vem na consulta do ciclo, não em lastCycle

scheduledAt
string<date>

Data prevista da cobrança (YYYY-MM-DD, sem hora)

Example:

"2025-07-30"

executedAt
string<date>

Data da última tentativa de cobrança (YYYY-MM-DD, sem hora). Não vem antes da primeira tentativa

Example:

"2025-07-30"

nextAttemptAt
string<date>

Data da próxima retentativa (YYYY-MM-DD, sem hora). Só vem quando há retentativa agendada

Example:

"2025-07-31"

isEmulated
boolean

Indica se o ciclo foi gerado por emulação em testes no sandbox. Em produção é sempre false

Example:

false

emulatedAt
string<date-time>

Data da emulação, quando houver

createdAt
string<date-time>

Data de criação do ciclo

Example:

"2025-07-30T20:14:12.599715Z"

paymentHistory
object[]

Tentativas de cobrança do ciclo