Cancela agora ou no fim do período (equipe)
POST/api/manage/subscriptions/{subscriptionId}/cancel
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- finance
- Clé d’API:
- sales:delete
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
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. Já encerrada, ou já marcada para encerrar: 409. A resposta é o detalhe depois da ação.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
subscriptionIdobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
immediatefacultatif | boolean | |
reasonfacultatif | string | max 500 |
Réponses
| Statut | Description |
|---|---|
200 | Detalhe depois da ação. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
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. |
Exemple 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 '{}'