Lista as assinaturas da comunidade (gestão pela equipe)
GET/api/manage/subscriptions
- Auth
- Token erforderlich
- Wer darf:
- owner
- admin
- finance
- X-CommunityId
X-CommunityIdSende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.
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.
Parameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
statusoptional | query | ACTIVE | TRIALING | PAST_DUE | PAUSED | CANCELING | CANCELED | EXPIRED | COMPLIMENTARY | |
productIdoptional | query | string (uuid) | Opção de cobrança |
subscriptionGroupIdoptional | query | string (uuid) | Plano |
fromoptional | query | string (date-time) | Início da assinatura a partir de |
tooptional | query | string (date-time) | Início da assinatura até |
searchoptional | query | string | Nome ou e-mail do membro |
pageoptional | query | integer | |
limitoptional | query | integer |
Header
| Name | Typ | Beschreibung |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Antworten
| Status | Beschreibung |
|---|---|
200 | Lista paginada. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
curl-Beispiel
curl -X GET "https://api.memberfy.net/api/manage/subscriptions" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"