Skip to main content
POST
/
public_api
/
subscriptions
/
{id}
/
pause
/
cURL
curl --request POST \
  --url https://api.cakto.com.br/public_api/subscriptions/{id}/pause/ \
  --header 'Authorization: Bearer <token>'
{
  "detail": "<string>"
}

​
Escopo

    write subscriptions

​
O que faz

Pausa uma assinatura ativa, interrompendo as cobranças recorrentes até que seja reativada. Útil quando o cliente solicita uma pausa temporária ou quando você precisa suspender o acesso sem cancelar definitivamente a assinatura.

​
Casos de uso

  • Atender solicitação do cliente para pausar o serviço temporariamente
  • Suspender cobranças durante resolução de disputas ou problemas técnicos
  • Evitar churn definitivo oferecendo pausa como alternativa ao cancelamento
  • Controlar acesso durante períodos de manutenção ou mudança de plano

​
Parâmetro

id (path) — Identificador único da assinatura.

​
Erros

StatusDescrição
400Assinatura não pode ser pausada no estado atual.
404Assinatura não encontrada.
Apenas assinaturas com status active podem ser pausadas.

Authorizations

​
Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

​
id
string<uuid>
required

Id da assinatura.

Response

Assinatura pausada.

​
detail
string
required

Mensagem de retorno da operação

​
status
enum<string>

Status atual da assinatura após a ação

Available options:
active,
inactive,
canceled,
expired,
paused,
trial