> ## Documentation Index
> Fetch the complete documentation index at: https://scaleup-c34c4386.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /api/v1/subscriptions/export

> Exporta todas as assinaturas da organização como arquivo CSV

Retorna um arquivo CSV com todas as assinaturas da organização, sem limite de paginação. Útil para relatórios e análises externas.

## Autenticação

> [!NOTE]
>
> Requer um token de acesso válido (`CHARGEFY_ACCESS_TOKEN`) no header `Authorization`. Escopos necessários: `web:read`, `web:write` ou `subscriptions:read`.

## Parâmetros de Query

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `organization_id` | `string` ou `string[]` | Condicional | ID da organização. **Obrigatório** quando autenticado com sessão de usuário. Opcional para tokens de acesso (OAT) — nesse caso, o padrão é a organização do token e suas sub-organizações diretas |

> [!WARNING]
>
> Para sessões de usuário (não-OAT), o parâmetro `organization_id` é obrigatório. Para tokens OAT, os `organization_id` informados precisam ser a própria organização do token ou uma sub-organização direta.

## Resposta

Retorna um arquivo `text/csv` com codificação UTF-8. O header `Content-Disposition` define o nome do arquivo como `chargefy-assinaturas.csv`.

**Colunas do CSV (na ordem):**

| Coluna | Descrição |
| - | - |
| `ID` | ID da assinatura |
| `Status` | Status atual da assinatura |
| `Organization ID` | ID da organização |
| `Customer Email` | E-mail do cliente |
| `Customer Name` | Nome do cliente |
| `Product` | Nome do produto |
| `Amount (cents)` | Valor em centavos |
| `Currency` | Moeda (ex: `BRL`) |
| `Recurring Interval` | Intervalo de recorrência (ex: `month`, `year`) |
| `Started At` | Data de início da assinatura |
| `Current Period End` | Data de fim do período atual |
| `Canceled At` | Data de cancelamento (se aplicável) |
| `Discount Code` | Código do desconto aplicado (se houver) |
| `Metadata (JSON)` | Metadados personalizados em formato JSON (se houver) |

## Exemplo de Requisição

```bash cURL theme={null}
curl -X GET "https://api.chargefy.io/api/v1/subscriptions/export?organization_id=org_111222" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  --output chargefy-assinaturas.csv
```

```typescript SDK theme={null}
import { Chargefy } from '@chargefy/sdk';

const chargefy = new Chargefy({
  accessToken: process.env.CHARGEFY_ACCESS_TOKEN,
});

const csv = await chargefy.subscriptions.export({ organization_id: 'org_111222' });
```

## Exemplo de Resposta

```csv theme={null}
ID,Status,Organization ID,Customer Email,Customer Name,Product,Amount (cents),Currency,Recurring Interval,Started At,Current Period End,Canceled At,Discount Code,Metadata (JSON)
sub_1a2b3c4d,active,org_111222,cliente@exemplo.com,João Silva,Plano Pro,4990,BRL,month,2026-01-15T10:30:00Z,2026-04-01T00:00:00Z,,,
sub_5e6f7g8h,canceled,org_111222,outro@exemplo.com,Maria Souza,Plano Básico,1990,BRL,month,2025-06-01T08:00:00Z,2026-01-01T00:00:00Z,2025-12-20T14:00:00Z,,
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.