Pausar assinatura

PATCH

/v1/subscriptions/{id}/pause

Pausa temporariamente a assinatura. Opcionalmente informe uma data até a qual ela permanece pausada e um motivo. Retorna o detalhe atualizado com status: PAUSED.

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

{

  

"paused_until": "2026-09-01",

  

"reason": "Cliente solicitou pausa temporária"

}

Respostas

Assinatura pausada. Retorna o detalhe atualizado.

Content-Type

application/json

{

  

"data": {

  

  

"subscription_id": 10,

  

  

"status": "PAUSED",

  

  

"paused_from": "2026-08-04 00:00:00",

  

  

"paused_until": "2026-09-01 00:00:00"

  

}

}

PATCH

/v1/subscriptions/{id}/pause

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

{
  "paused_until": "2026-09-01",
  "reason": "Cliente solicitou pausa temporária"
}

Duplo clique no JSON para editar