Saltar para o conteúdo

Lista as assinaturas da comunidade (gestão pela equipe)

GET/api/manage/subscriptions

Auth
Exige token
Quem pode:
owner
admin
finance
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

F-45. Exige owner, admin ou finance da comunidade do `X-CommunityId`. Mais novas primeiro. Cada item: `member` (nome, e-mail), `plan` e `product` (opção), `status` e `statusLabel` (`CANCELING` quando vai encerrar no fim do período), `source` (`CHECKOUT` ou `MANUAL`), `isComplimentary` e `complimentaryUntil`, valor (`billingAmount`, `regularAmount`, `discountPercent`, `discountEndsAt`), `addOns` cobrados junto, `nextChargeTotal`, `paymentMethod`, `pendingRenewal` (PIX/boleto em aberto), `commitmentEndsAt`, `nextBillingDate` e o período. Adicionais cobrados com o plano não aparecem como item próprio. Nunca traz custo de provedor.

Parâmetros

NomeOndeTipoDescrição
statusopcionalqueryACTIVE | TRIALING | PAST_DUE | PAUSED | CANCELING | CANCELED | EXPIRED | COMPLIMENTARY
productIdopcionalquerystring (uuid)Opção de cobrança
subscriptionGroupIdopcionalquerystring (uuid)Plano
fromopcionalquerystring (date-time)Início da assinatura a partir de
toopcionalquerystring (date-time)Início da assinatura até
searchopcionalquerystringNome ou e-mail do membro
pageopcionalqueryinteger
limitopcionalqueryinteger

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
200Lista paginada.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Exemplo com curl

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