Archive Usage Limit Plan

Archives one Usage Limit Plan in a project. The Plan is hidden from the default Plan list and from published Plan selectors, but its published revision remains available to subject routes that were already configured to use the Plan.

POST /v1/projects/:project_id/usage-limit-plans/:id/archive

Authentication

Requires an API key with usage_control:write.

Request

The request body is empty.

Path field	Required	Description
project_id	Yes	Project that owns the Usage Limit Plan.
id	Yes	Usage Limit Plan ID.

Response

{
  "id": "ulp_01J...",
  "tenant_id": "t_001",
  "project_id": "proj_gateway",
  "name": "pro-monthly",
  "title": "Pro monthly allowance",
  "description": "Default monthly control for Pro routes",
  "status": "archived",
  "current_revision": 2,
  "created_at": 1784890000,
  "updated_at": 1784894400
}

Field	Description
id	Usage Limit Plan ID.
tenant_id	Tenant that owns the Plan.
project_id	Project that owns the Plan.
name	Stable Plan name, unique within the project.
title	Display title.
description	Optional Plan description.
status	archived after this request succeeds.
current_revision	Last published revision number, or 0 if the Plan was never published.
created_at, updated_at	Unix timestamps in seconds.

Behavior

Archiving is a management lifecycle change, not a realtime limit reset. It does not mutate published Plan versions, active subject routes, realtime limit accumulators, historical usage, wallet balances, or ledger records.

The default GET /v1/projects/:project_id/usage-limit-plans response excludes archived Plans. GET /v1/projects/:project_id/usage-limit-plans?archived=true returns archived Plans. GET /v1/projects/:project_id/usage-limit-plans?published=true also excludes archived Plans so new route assignments use active Plans.

Already-bound subject routes continue resolving the archived Plan’s published limits until the route policy is changed.

Use Restore Usage Limit Plan to return an archived Plan to active management lists and route selectors.