Cancelar assinatura

PATCH

/v1/subscriptions/{id}/cancel

Cancela a assinatura de forma definitiva — nenhuma nova cobrança será gerada. Opcionalmente registre um motivo. Retorna o detalhe atualizado com status: CANCELLED e canceled_at preenchido.

Autorizações

bearerAuth

Token Bearer do merchant obtido via POST /oauth2/token usando as credenciais do merchant (não do app). Veja Autenticação.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

id*

Identificador da assinatura.

Tipo

integer

Obrigatório

Exemplo10

Corpo da Requisição

application/json

{

  

"reason": "Cliente não deseja mais o produto"

}

Respostas

Assinatura cancelada. Retorna o detalhe atualizado.

Content-Type

application/json

{

  

"data": {

  

  

"subscription_id": 10,

  

  

"status": "CANCELLED",

  

  

"canceled_at": "2026-08-04 12:00:00"

  

}

}

PATCH

/v1/subscriptions/{id}/cancel

Exemplos

Sandboxhttps://api.sandboxappmax.com.br

Parâmetros da URL

id

Authorization (Bearer)

Cole uma vez e use em todos os playgrounds — o token fica salvo somente nesta aba do navegador e é apagado quando ela for fechada.

Corpo

{
  "reason": "Cliente não deseja mais o produto"
}

Duplo clique no JSON para editar