Pular para o conteúdo principal
PATCH
Cancelar uma assinatura
Use este endpoint para cancelar uma assinatura existente. Essa ação impedirá quaisquer pagamentos recorrentes futuros associados à assinatura. Observações importantes:
  • O cancelamento pode não resultar em reembolso pelo período de assinatura restante. Consulte os termos da sua assinatura para obter detalhes sobre reembolsos.
  • Certifique-se de cancelar a assinatura antes da próxima data de faturamento para evitar cobranças indesejadas.
  • Você pode usar o endpoint Obter Status da Assinatura para verificar o cancelamento.
Este endpoint exige um subscriptionId válido. Uma vez cancelada, a assinatura não pode ser reativada. Você precisará criar uma nova assinatura para reativar o serviço.

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

subscriptionId
string
obrigatório

Corpo

application/json
status
any
obrigatório

Alterar o status para CANCELLED.

Resposta

OK

externalId
string

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

Identificador único para a assinatura.

status
status · object

Status da operação.

totalPayments
integer

Número total de pagamentos associados à assinatura.

pendingPayments
integer

Número de pagamentos ainda pendentes referentes à assinatura.

creationDate
string

Data e hora em que a assinatura foi criada. O formato deve seguir uma sequência de data e hora válida (por exemplo, ISO 8601).

payments
object[]

Conjunto de objetos representando os pagamentos associados à assinatura.

retries
integer

Número de tentativas de reenvio realizadas para processar os pagamentos da assinatura.

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