# Override an organization's plan

> The platform_billing.plan_override.set operation: PUT /api/v1/platform/organizations/{orgId}/plan_override in the REST API and the platform_billing_plan_override_set tool in the MCP server.

Gives an organization the entitlements of one of Ownrecord's plans (`plan`, a key of data/platform/plans.yaml
such as `growth` or `internal`) whatever it pays for, until `expiresAt` or until removed
(`platform_billing.plan_override.remove`). The override names its plan: an organization on `internal` isn't
metered. It replaces an earlier override. Its billing (the subscription, invoices, the unpaid-plan escalation)
doesn't change. Platform admins only; the reason is recorded in the organization's audit log.

## At a glance

- **REST:** `PUT /api/v1/platform/organizations/{orgId}/plan_override`
- **MCP tool:** `platform_billing_plan_override_set`
- **Operation ID:** `platform_billing.plan_override.set`
- **Scope:** Platform
- **Permission:** `platform:admin`
- **Risk tier:** `security`
- **Dry run:** Supported (send `Ownrecord-Dry-Run: true`)
- **Idempotency:** `Idempotency-Key` optional
- **Modes:** Test and live
- **Authentication:** API key with the `platform:admin` scope
- **Fresh sign-in:** In the console, a sign-in within the last 15 minutes
- **Since:** M13

## Request

### Path parameters

| Field   | Type       | Description                 |
| ------- | ---------- | --------------------------- |
| `orgId` | `org_…` ID | The organization (`org_…`). |

### Body

A JSON object (`Content-Type: application/json`):

| Field       | Type      | Required | Description                                                                         |
| ----------- | --------- | -------- | ----------------------------------------------------------------------------------- |
| `plan`      | string    | Yes      | A plan key of data/platform/plans.yaml, e.g. `growth`.                              |
| `expiresAt` | date-time | No       | When the override ends (ISO 8601, in the future); left out, it lasts until removed. |
| `reason`    | string    | Yes      | Why, for the audit log and the support team.                                        |

## Response

`200 OK` with a JSON object:

| Field      | Type                       | Description |
| ---------- | -------------------------- | ----------- |
| `object`   | `"platform_plan_override"` |             |
| `orgId`    | string                     |             |
| `override` | object or null             |             |

## Examples

### Growth for a design partner until the end of the pilot

```http
PUT /api/v1/platform/organizations/org_01jbz3m4k5n6p7q8r9s0t1v2w3/plan_override
Authorization: Bearer or_test_…
Content-Type: application/json

{
  "plan": "growth",
  "expiresAt": "2027-03-31T00:00:00.000Z",
  "reason": "Design partner: Growth free until the end of the pilot"
}
```

Response (`200`):

```json
{
  "object": "platform_plan_override",
  "orgId": "org_01jbz3m4k5n6p7q8r9s0t1v2w3",
  "override": {
    "plan": "growth",
    "planName": "Growth",
    "entitlements": {
      "api.rate_limit_rps": 100,
      "assistant.enabled": true,
      "assistant.messages_per_month": 1000,
      "audit.retention_days": 90,
      "brands.max": 3,
      "custom_domains.max": 2,
      "einvoicing.enabled": true,
      "entities.max": 2,
      "filing.reports": "full",
      "jurisdictions.registered.max": 10,
      "livemode": true,
      "members.max": 10,
      "processors.secondary": false,
      "sso.enabled": false,
      "subscriptions.enabled": true,
      "support.level": "email",
      "usage_billing.enabled": true
    },
    "reason": "Design partner: Growth free until the end of the pilot",
    "setBy": "usr_01jbz3m4k5n6p7q8r9s0t1v2w7",
    "expiresAt": "2027-03-31T00:00:00.000Z",
    "active": true
  }
}
```

## Errors

| Code                                                                                       | HTTP status | When                                                                                                                                           | What to do                                                                                           |
| ------------------------------------------------------------------------------------------ | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| [`validation_failed`](https://ownrecord.io/docs/reference/errors.md#validation_failed)     | 400         | The plan isn't one of data/platform/plans.yaml, the end date is in the past, the reason is missing, or the organization is the platform's own. | Fix the fields listed in `details.issues` and send the request again.                                |
| [`resource_not_found`](https://ownrecord.io/docs/reference/errors.md#resource_not_found)   | 404         | There is no such organization.                                                                                                                 | Check the ID and that your credentials are scoped to the right organization, entity, brand and mode. |
| [`version_conflict`](https://ownrecord.io/docs/reference/errors.md#version_conflict)       | 409         | The organization changed at the same time; retry.                                                                                              | Fetch the object again and retry the change.                                                         |
| [`permission_denied`](https://ownrecord.io/docs/reference/errors.md#permission_denied)     | 403         | Only a platform_admin overrides an organization's plan.                                                                                        | Ask an organization owner or admin for a role or scope that allows this action.                      |
| [`fresh_auth_required`](https://ownrecord.io/docs/reference/errors.md#fresh_auth_required) | 403         | Your last sign-in is older than 15 minutes: sign in again first.                                                                               | Sign in again, then repeat the action within 15 minutes.                                             |

It can also return these [common errors](https://ownrecord.io/docs/reference.md#common-errors): [`api_version_unsupported`](https://ownrecord.io/docs/reference/errors.md#api_version_unsupported), [`invalid_json`](https://ownrecord.io/docs/reference/errors.md#invalid_json), [`unsupported_media_type`](https://ownrecord.io/docs/reference/errors.md#unsupported_media_type), [`authentication_required`](https://ownrecord.io/docs/reference/errors.md#authentication_required), [`api_key_invalid`](https://ownrecord.io/docs/reference/errors.md#api_key_invalid), [`idempotency_key_reused`](https://ownrecord.io/docs/reference/errors.md#idempotency_key_reused), [`idempotency_in_progress`](https://ownrecord.io/docs/reference/errors.md#idempotency_in_progress), [`rate_limited`](https://ownrecord.io/docs/reference/errors.md#rate_limited), [`internal_error`](https://ownrecord.io/docs/reference/errors.md#internal_error).