---
title: "Ask for an account export"
method: POST
path: "/v1/me/export"
tags: ["Me"]
---

# Ask for an account export

`POST /v1/me/export`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/me/export`
- Auth: HTTP bearer

```bash
curl -X POST https://api.subscriby.net/v1/me/export -H "Authorization: Bearer $SUBSCRIBY_TOKEN" -H "Idempotency-Key: 7c1b2d3e-4f5a-6b7c-8d9e-0f1a2b3c4d5e"
```

Queues an archive of everything the caller's account holds: the account as `GET /v1/me` describes it, the webhook endpoints (never their signing secrets), the platform subscription with its invoices, and for every project the plans, resources, payment methods (never their keys), members, subscriptions, payments, coupons, dated windows and support conversations, each as a JSON file in the shape this API publishes, plus one workbook per project with a sheet per table. Answers `202` with the queued export. The build runs in the background and takes from seconds to a few minutes; the creator is also emailed a signed link when it is ready.

One export may be in flight per account and one may be requested a day; a second request is `422 VALIDATION_FAILED` with the reason and, for the daily limit, when the next one is allowed. Read the existing export instead.

> **The archive holds the members' personal data.** Hand the link only to the creator who owns the token, and treat the file as you would their database.

## Headers

- `Idempotency-Key` string, uuid, required

## Response `202`

202 with the queued export.

- object
  - `data` AccountExportResource, required: One export of the caller's account: its state, when it was asked for and finished, how long its archive lives, and a signed link to download it while it is ready.
    - `id` string, required: The export's id.
    - `status` string, required: `queued`, `building`, `ready`, `failed` or `expired`. Only `ready` carries a `download_url`.
    - `reason` string, required: `manual` for a request from Settings or the API, `deletion` for the archive a scheduled account deletion builds.
    - `requested_at` string, required: When the export was asked for, ISO 8601.
    - `completed_at` string, nullable, required: When the build finished, ISO 8601, or null while it runs.
    - `expires_at` string, nullable, required: When the archive is removed, ISO 8601, or null before it exists.
    - `size_bytes` integer, nullable, required: The archive's size, or null before it exists.
    - `projects_count` integer, nullable, required: How many projects the archive holds, or null before it exists.
    - `download_url` string, nullable, required: A signed link to the zip, present only while `status` is `ready`; it stops working at `download_url_expires_at`, and reading the export again mints a fresh one.
    - `download_url_expires_at` string, nullable, required: When `download_url` stops working, ISO 8601, or null without a link.

## Other responses

- `400`: `IDEMPOTENCY_KEY_MISSING`: every write needs an `Idempotency-Key` header. Send a fresh UUID per distinct operation.
- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `409`: `IDEMPOTENCY_KEY_REUSED`: the key was already used in the last 24 hours with a different request body.
- `425`: `IDEMPOTENCY_REPLAY_IN_PROGRESS`: the first request with this key is still running; retry in a few seconds and the original response is replayed.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)