Cancela agora ou no fim do período (equipe)
POST/api/manage/subscriptions/{subscriptionId}/cancel
- Auth
- Requiere token
- Quién puede:
- owner
- admin
- finance
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
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
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
subscriptionIdobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
| Nombre | Tipo | Descripción |
|---|---|---|
immediateopcional | boolean | |
reasonopcional | string | max 500 |
Respuestas
| Código | Descripción |
|---|---|
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. |
Ejemplo con 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 '{}'