---
title: "Label a plan"
method: PATCH
path: "/api/v1/plans/{id}"
tags: ["Plans & line generation"]
---

# Label a plan

`PATCH /api/v1/plans/{id}`

## Request

- Base URL: `https://hproxy.com`
- URL: `https://hproxy.com/api/v1/plans/{id}`
- Auth: API key in header `X-API-Key`

`PATCH` a plan with your own reference, e.g. which of YOUR customers it belongs to. Pure metadata: it changes nothing about pricing, traffic or generation, and it comes back in `GET /plans`, `GET /plans/{id}` and in [webhook](/docs/proxy-api/webhooks) payloads, so every signal is already attributed to your customer. `null` (or an empty body) clears it.

## Path parameters

- `id` string, required

## Request body

- object
  - `label` string: 1 to 64 characters, no control characters. null/omitted clears.

## Response `200`

Success

- object

## Other responses

- `400`: Invalid input. The body names the field and the accepted set.
- `401`: Missing or invalid API key.
- `429`: Rate limited. Retry after the delay in the response.

---

[API](https://skmtc.dev/hproxy/apis/hproxy-api.md) · [All operations](https://skmtc.dev/hproxy/apis/hproxy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hproxy/apis/hproxy-api/revisions/9f6898fe76e2?raw)
