Cria uma assinatura manual (cortesia ou cobrança futura)
POST/api/manage/subscriptions
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- finance
- Clé d’API:
- sales:write
- 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. `mode = COMPLIMENTARY`: cortesia, sem cobrança e sem lançamento no extrato, até `complimentaryUntil` (encerra sozinha) ou sem fim. `mode = FUTURE_CHARGE`: grátis até `chargeStartsAt` e cobrada a partir dessa data como qualquer assinatura — por PIX/boleto (`paymentMethod`; a cobrança sai alguns dias antes e vai por e-mail) ou pelo cartão salvo do membro (`CREDIT_CARD`). O membro pode receber um link para pagar ou cadastrar cartão (`POST .../payment-link`). Membro que já assina a mesma opção: 409. Membro ou opção de outra comunidade: 404.
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 |
|---|---|---|
memberIdobligatoire | string (uuid) | |
productIdobligatoire | string (uuid) | Opção de cobrança (produto SUBSCRIPTION) |
modeobligatoire | COMPLIMENTARY | FUTURE_CHARGE | |
complimentaryUntilfacultatif | string (date-time) | |
chargeStartsAtfacultatif | string (date-time) | Obrigatório em FUTURE_CHARGE |
paymentMethodfacultatif | PIX | BOLETO | CREDIT_CARD | FUTURE_CHARGE; padrão PIX |
notefacultatif | string | max 500 |
Réponses
| Statut | Description |
|---|---|
201 | Assinatura criada (formato do detalhe). |
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 | O membro já assina esta opção. |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/manage/subscriptions" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"memberId":"00000000-0000-0000-0000-000000000000","productId":"00000000-0000-0000-0000-000000000000","mode":"COMPLIMENTARY"}'