Archive a project
Switches the project off: active becomes false, the portal stops selling, and every plan, member and payment method is kept. Archive and restore are RPC-style actions separate from the update: they preserve the project's data while flipping active, so prefer them over delete when you want to pause intake without losing history. Answers 200 with the project and emits project.archived. Gated on project:update, not project:delete, because it flips one column of the project.
Request
- Base URL: https://api.subscriby.net
- URL: https://api.subscriby.net/v1/projects/{project}/archive
- Auth: HTTP bearer
Path parameters
The project, resolved by the route binder.
Headers
A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.
Response
The project, inactive.
Example response
{
"data": {
"id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
"team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",
"user_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",
"name": "Research Premium",
"handle": "research-premium",
"description": "Weekly deep-dive research notes.",
"terms": "https://example.com/terms",
"privacy": "https://example.com/privacy",
"banner_url": "https://static.subscriby.net/projects/7f3d1c92/banner.webp",
"photo_url": "https://static.subscriby.net/projects/7f3d1c92/photo.webp",
"metrics": true,
"outage_compensations": true,
"active": true,
"created_at": "2026-05-18T10:05:00Z",
"updated_at": "2026-05-18T10:05:00Z"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.