Saltar para o conteúdo

Cancela agora ou no fim do período (equipe)

POST/api/manage/subscriptions/{subscriptionId}/cancel

Auth
Exige token
Quem pode:
owner
admin
finance
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

F-45. Owner, admin ou finance; auditado. `immediate: true` encerra agora; sem ele, a assinatura fica ativa até o fim do período pago e não renova. A equipe passa por cima do contrato (F-35). Já encerrada, ou já marcada para encerrar: 409. A resposta é o detalhe depois da ação.

Parâmetros

NomeOndeTipoDescrição
subscriptionIdobrigatóriopathstring (uuid)

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corpo da requisição application/json

NomeTipoDescrição
immediateopcionalboolean
reasonopcionalstringmax 500

Respostas

CódigoDescrição
200Detalhe depois da ação.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409A assinatura não aceita a ação no estado atual.
500Erro interno do servidor.

Exemplo com curl

curl -X POST "https://api.memberfy.net/api/manage/subscriptions/<subscriptionId>/cancel" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'