Cria ou executa subscriptions
POST/api/subscription-groups
- Auth
- Requires a token
- Who can call it:
- owner
- admin
- SuperAdmin
- 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.
Cria um grupo de assinatura. Exige owner, admin ou SuperAdmin. A comunidade é a do X-CommunityId. productIds precisam ser produtos não excluídos dessa comunidade. slug é o endereço do plano nos links públicos (/pricing/<slug>/...): sem ele, é gerado do nome (sem acento, minúsculo, hífens; -2, -3 em caso de colisão). slug enviado e já usado por outro plano da comunidade, ativo ou não, responde 400 com param slug. Responde 201.
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 |
|---|---|---|
namerequired | string | Name is required |
slugoptional | string | Endereço do plano nos links públicos. Opcional; sem ele, é gerado do nome. Único na comunidade. · max 60 |
descriptionoptional | string | |
sortOrderoptional | integer | |
metadataoptional | object | |
productIdsoptional | —[] | productIds must be an array |
productIds.*optional | string (uuid) | Each productId must be a valid UUID |
addOnProductIdsoptional | string (uuid)[] | Adicionais do plano (F-37): produtos que podem ser somados a ele. Grava em product_prerequisites, a mesma relação do prerequisiteGroupIds do produto, vista do plano. Omitido mantém a lista; [] limpa. Cada produto precisa ser desta comunidade, não excluído e não ser opção de nenhum plano, senão 400 com param addOnProductIds. Só os SUBSCRIPTION MONTHLY são vendidos junto com o plano; os outros valem como pré-requisito de compra. |
Responses
| Status | Description |
|---|---|
201 | Operação realizada com sucesso. |
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. |
500 | Erro interno do servidor. |
curl example
curl -X POST "https://api.memberfy.net/api/subscription-groups" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'