Skip to main content
POST
/
api
/
subscriptions
/
{id}
/
pause
Pausar Assinatura
curl --request POST \
  --url https://garu.com.br/api/subscriptions/{id}/pause \
  --header 'Authorization: Bearer <token>'

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

Pause temporariamente as cobranças de uma assinatura. O cliente pode manter ou perder acesso durante a pausa, dependendo da sua implementação. Use o endpoint de retomar para reativar as cobranças.

​
Exemplo de Requisição

curl -X POST https://garu.com.br/api/subscriptions/100/pause \
  -H "Authorization: Bearer sk_test_sua_chave"

​
Resultado

  • Status muda para paused
  • Cobranças são suspensas
  • Nenhum pagamento será tentado enquanto pausada
  • Use retomar para reativar

​
Resposta de Sucesso (200 OK)

{
  "id": 100,
  "status": "paused",
  "pausedAt": "2024-02-20T10:00:00.000Z",
  "message": "Assinatura pausada com sucesso"
}

​
Considerações

Acesso durante a pausa: A decisão de manter ou revogar o acesso do cliente durante a pausa é da sua aplicação. A Garu apenas suspende as cobranças.
Assinaturas pausadas por muito tempo podem precisar de atualização do método de pagamento ao serem retomadas.

​
Erros Comuns

{
  "statusCode": 404,
  "message": "Subscription not found"
}
Solução: Verifique se o ID da assinatura está correto.
{
  "statusCode": 400,
  "message": "Cannot pause subscription with current status"
}
Solução: Apenas assinaturas ativas podem ser pausadas.

​
Próximos Passos

Retomar Assinatura

Reative as cobranças de uma assinatura pausada

Cancelar Assinatura

Cancele definitivamente uma assinatura