Skip to main content
POST
/
api
/
scheduled-charges
/
{id}
/
pause
Pausar Cobrança
curl --request POST \
  --url https://garu.com.br/api/scheduled-charges/{id}/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.garu.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Visão Geral

Pausa a cobrança. Nenhum e-mail (cliente ou time) é enviado até você retomá-la com /resume. Permitido a partir de: scheduled / due_today / overdue.

​
Exemplo de Requisição

curl -X POST https://garu.com.br/api/scheduled-charges/sch_abc123/pause \
  -H "Authorization: Bearer sk_test_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{ "reason": "em negociação" }'

​
Parâmetros

​
id
string
required
ID da cobrança (sch_…).
​
reason
string
Texto livre persistido no log de auditoria.

​
Resposta

A cobrança atualizada com status: "paused". Um evento paused é apendado e o webhook scheduled_charge.paused é disparado.