Pular para o conteúdo

Lista ou consulta subscription groups

GET/api/checkout/subscription-groups

Auth
Pública
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Endpoint público — não exige autenticação. Adicionais (produtos com `prerequisiteGroupIds`) só aparecem para quem tem assinatura ACTIVE ou TRIALING num dos grupos exigidos; o token é opcional e, sem ele, nenhum adicional aparece. Cada produto traz `prerequisiteGroupIds` (vazio quando não é adicional). Cada grupo traz `slug`, o endereço do plano nos links públicos (`/pricing/<slug>/<optionKey>`). Cada produto traz `optionKey`, o segmento da opção de cobrança nesse link: `mensal` (MONTHLY sem contrato), `N-meses` (MONTHLY com commitmentMonths N), `anual` (YEARLY), ou null nos demais intervalos. Dois produtos do mesmo grupo podem ter o mesmo `optionKey`. F-37: cada grupo traz `addOns`, os adicionais da lista do plano à venda, visíveis a qualquer um, com ou sem plano: `productId`, `title`, `shortDescription`, `price` (mensal), `currency`, `feePayer` e `sellsWithPlan` (`SUBSCRIPTION` `MONTHLY`: pode ser comprado junto com o plano). Cada opção que aceita adicional (MONTHLY ou YEARLY, sem teste) traz `addOnAmounts`: `[{ productId, amount, interval }]`, o valor de cada adicional vendido junto no ritmo da opção (o mensal, ou 12 × o mensal no anual), sem a taxa paga pelo comprador. Opção que não aceita adicional não traz o campo. Cada produto traz `thankYouMessage` e `redirectUrl` (opcionais, null quando vazios).

Headers

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

Respostas

CódigoDescrição
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
500Erro interno do servidor.

Exemplo com curl

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