Vai al contenuto

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

GET/api/manage/subscriptions

Auth
Richiede un token
Chi può:
owner
admin
finance
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

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.

Parametri

NomeDoveTipoDescrizione
statusfacoltativoqueryACTIVE | TRIALING | PAST_DUE | PAUSED | CANCELING | CANCELED | EXPIRED | COMPLIMENTARY
productIdfacoltativoquerystring (uuid)Opção de cobrança
subscriptionGroupIdfacoltativoquerystring (uuid)Plano
fromfacoltativoquerystring (date-time)Início da assinatura a partir de
tofacoltativoquerystring (date-time)Início da assinatura até
searchfacoltativoquerystringNome ou e-mail do membro
pagefacoltativoqueryinteger
limitfacoltativoqueryinteger

Header

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

Risposte

CodiceDescrizione
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.

Esempio con curl

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