Pular para o conteúdo principal
GET
Verificar assinatura

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string
obrigatório

Token de acesso Bearer para autenticação. Este token é obtido nos endpoints Obter token de acesso ou Renovar token de acesso.

Parâmetros de caminho

externalId
string
obrigatório

ID da assinatura.

Resposta

OK

externalId
string
obrigatório

Um identificador único gerado pelo seu sistema para rastrear a transação (alfanumérico e com hífens). Recomendamos o uso do UUID4 para garantir a unicidade.

subscriptionId
string
obrigatório

O ID foi atribuído no momento em que a assinatura foi criada.

status
object
obrigatório

Status da operação.

totalPayments
integer
obrigatório

Número total de pagamentos efetuados.

pendingPayments
integer
obrigatório

Número de pagamentos que ainda não foram recebidos.

creationDate
string
obrigatório

Data em que a assinatura foi criada.

nextPaymentDate
string
obrigatório

Data do próximo pagamento.

request
object
obrigatório
payments
object[]
obrigatório
retries
integer

Número de tentativas.

Última modificação em 10 de novembro de 2026