Cancela agora ou no fim do período (equipe)
POST/api/manage/subscriptions/{subscriptionId}/cancel
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- finance
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
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.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
subscriptionIdobbligatorio | path | string (uuid) |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
immediatefacoltativo | boolean | |
reasonfacoltativo | string | max 500 |
Risposte
| Codice | Descrizione |
|---|---|
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. |
Esempio 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 '{}'