Aller au contenu

Lista subscriptions

GET/api/subscription-groups

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
finance
Clé d’API:
store:read
X-CommunityId
X-CommunityId Envoyez 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.

Lista os grupos de assinatura ativos da comunidade, com produtos e contagem de assinaturas ativas: activeSubscriptionsCount no grupo e activeSubscriptions em cada produto contam as assinaturas em vigor (ACTIVE, TRIALING, PAST_DUE ou PAUSED), o mesmo critério do activeSubscriptionsCount de GET /api/products. Cada grupo traz slug, o endereço do plano nos links públicos (/pricing/<slug>/...), e addOnProductIds, a lista de adicionais do plano. Listagem de gestão: owner, admin ou finance; outros papéis recebem 403. Um membro lê os planos públicos em GET /api/checkout/subscription-groups. A comunidade é a do X-CommunityId. Só devolve grupos dessa comunidade.

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Réponses

StatutDescription
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/subscription-groups" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"