Skip to content

Lista subscriptions

GET/api/subscriptions

Auth
Requires a token
X-CommunityId
X-CommunityId Send 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.

Cada assinatura traz `commitmentEndsAt` (fim do contrato vigente, ou `null` sem contrato) e `cancelEffectiveAt` (quando um cancelamento agendado de fato encerra a assinatura, ou `null`), e `product.commitmentMonths` (F-35). F-37: `billedWithId` é a assinatura do plano com que um adicional é cobrado (o adicional não traz os campos abaixo); nas outras, `billedWithId = null`, `addOns` (os adicionais cobrados junto: `id`, `productId`, `title`, `status`, `billingAmount`, `canceledAt`, `renewsWithPlan`) e `nextChargeTotal` (o plano mais os adicionais que renovam com ele, sem a taxa paga pelo comprador; `null` sem próxima cobrança). `pendingRenewal`: a cobrança de renovação em aberto que a assinatura espera — o PIX ou boleto gerado antes do vencimento (F-38), o de "Pagar agora", ou um cartão em análise — ou `null`. Forma: `{ purchaseId, paymentMethod, amount, dueDate, pixCode, qrCode, boletoUrl, boletoBarcode }`. `amount` é o total do pedido (plano e adicionais), o que o membro paga. `pixCode` (copia e cola), `qrCode` (URL da imagem), `boletoUrl`, `boletoBarcode` (linha digitável) e `dueDate` (validade do PIX ou vencimento do boleto) vêm do pedido na Stone e são `null` no cartão ou quando o provedor não responde. Sempre `null` num adicional ligado: a cobrança aparece no plano.

Headers

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

Responses

StatusDescription
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
500Erro interno do servidor.

curl example

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