Pausar ou retomar notificações da cobrança

POST /billing/integration/{integration_identifier}/pause-notifications

Pausa ou retoma os lembretes de uma cobrança já existente, identificada pelo integration_identifier.

Requisição

Headers

Header	Valor
Content-Type	application/json
api-key	Sua chave de API
secret-key	Sua senha de API

Path

Campo	Tipo	Obrigatório	Descrição
integration_identifier	string	Sim	Identificador da cobrança enviado na criação

Body

{
  "pause_notifications": true,
  "reason": "Solicitação do cliente"
}

Campo	Tipo	Obrigatório	Descrição
pause_notifications	boolean	Sim	`true` pausa os lembretes. `false` retoma. Enviar boolean JSON, não string
reason	string	Condicional	Motivo gravado no histórico. Obrigatório quando `pause_notifications` é `true`. Não pode ser vazio. Na retomada pode omitir

Importante: pause_notifications é sempre obrigatório. reason só é obrigatório na pausa.

Comportamento

Ao receber a requisição, o endpoint:

Localiza a cobrança pelo integration_identifier da company autenticada.

Seleciona as parcelas elegíveis. Parcelas pending e overdue entram. Parcelas paid, cancelled, canceled, cancelling, deleted ou deleting ficam de fora.

Enfileira a pausa ou a retomada de cada parcela elegível.

O processamento é assíncrono. A API retorna 202 Accepted assim que a solicitação é enfileirada, antes que a flag pause_notifications seja gravada.

A cobrança continua aberta. O status não muda.

Se a cobrança tiver uma única parcela ativa, a mesma flag também é gravada na cobrança.

Respostas

202 Accepted

Solicitação enfileirada com sucesso.

{
  "message": "Installment pause_notifications enqueued successfully",
  "errors": {},
  "enqueued": 1,
  "installment_ids": ["2d0378a6-0000-0000-0000-000000000000"],
  "pause_notifications": true
}

Campo	Tipo	Descrição
message	string	Confirmação do enfileiramento
errors	object	Vazio em sucesso
enqueued	integer	Quantidade de parcelas enfileiradas
installment_ids	string[]	Ids das parcelas enfileiradas
pause_notifications	boolean	Valor pedido (`true` ou `false`)

400 Bad Request

Campo obrigatório ausente ou inválido.

pause_notifications ausente ou null:

{
  "message": "pause_notifications is required",
  "errors": {}
}

Pausa sem motivo, ou motivo em branco:

{
  "message": "reason is required when pause_notifications is true",
  "errors": {}
}

404 Not Found

Cobrança inexistente nessa company:

{
  "message": "Billing not found.",
  "errors": {}
}

Cobrança existe, mas não há parcela elegível:

{
  "message": "Installments not found.",
  "errors": {}
}

500 Internal Server Error

Erro inesperado durante o enfileiramento.

{
  "message": "Problems pausing installment notifications. Try again in a few moments.",
  "errors": {}
}

Exemplos

Pausar lembretes

Retomar lembretes

Observações

Parcelas pagas, canceladas ou excluídas não são alteradas.

Chamar de novo com o mesmo valor grava a flag outra vez e gera um novo evento no histórico.

Pausar ou retomar notificações da cobrança

Requisição#

Headers#

Path#

Body#

Comportamento#

Respostas#

202 Accepted#

400 Bad Request#

404 Not Found#

500 Internal Server Error#

Exemplos#

Pausar lembretes#

Retomar lembretes#

Observações#