Cancela agora ou no fim do período (equipe)
POST/api/manage/subscriptions/{subscriptionId}/cancel
- Auth
- Requires a token
- Who can call it:
- owner
- admin
- finance
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
subscriptionIdrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
immediateoptional | boolean | |
reasonoptional | string | max 500 |
Responses
| Status | Description |
|---|---|
200 | Detalhe depois da ação. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | A assinatura não aceita a ação no estado atual. |
500 | Erro interno do servidor. |
curl example
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 '{}'