Exporta as assinaturas da comunidade em CSV
GET/api/manage/subscriptions/export.csv
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- finance
- Clé d’API:
- sales:read
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
Owner, admin ou finance. Mesmos filtros da listagem, sem paginação. Até 2.000 linhas o CSV vem na resposta; acima disso a resposta é 202 e o arquivo (sem o limite de 5.000 linhas da resposta direta) chega por e-mail. Colunas: id, member, email, plan, option, status, billingAmount, currency, discountPercent, addOns, paymentMethod, nextBillingDate, currentPeriodEnd, commitmentEndsAt, source, complimentaryUntil, startDate, canceledAt. UTF-8 com BOM; célula que começaria uma fórmula vem com `'` na frente.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
statusfacultatif | query | string | |
productIdfacultatif | query | string (uuid) | |
subscriptionGroupIdfacultatif | query | string (uuid) | |
fromfacultatif | query | string (date-time) | |
tofacultatif | query | string (date-time) | |
searchfacultatif | query | string |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Réponses
| Statut | Description |
|---|---|
200 | CSV, uma linha por assinatura. |
202 | Exportação grande (mais de 2.000 linhas): o arquivo não vem na resposta. Ele é gerado numa fila com os mesmos filtros, guardado de forma privada e o link (válido por 72 horas) vai por e-mail para quem pediu. `data.email` é o endereço que recebe; se a pessoa perder o papel antes da geração, recebe um aviso de falha em vez do link. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
Exemple curl
curl -X GET "https://api.memberfy.net/api/manage/subscriptions/export.csv" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"