Remove an organization's plan override

Ends a platform admin's plan override (platform_billing.plan_override.set): the organization gets the entitlements of the plan it pays for again, at once. Removing an organization without an override changes nothing. Platform admins only; the reason is recorded in the organization's audit log.

At a glance

REST: DELETE /api/v1/platform/organizations/{orgId}/plan_override
MCP tool: platform_billing_plan_override_remove
Operation ID: platform_billing.plan_override.remove
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
`reason`	string	Yes	Why, for the audit log.

Response

200 OK with a JSON object:

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

Examples

End a pilot's override

HTTP

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

{
  "reason": "The pilot ended; the customer subscribed to Growth"
}

Response (200):

JSON

{
  "object": "platform_plan_override",
  "orgId": "org_01jbz3m4k5n6p7q8r9s0t1v2w3",
  "override": null
}

Errors

Code	HTTP status	When	What to do
`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.
`validation_failed`	400	The organization ID or the reason is missing or malformed.	Fix the fields listed in `details.issues` and send the request again.
`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`	409	The organization changed at the same time; retry.	Fetch the object again and retry the change.
`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.

It can also return these common errors: api_version_unsupported, invalid_json, unsupported_media_type, authentication_required, api_key_invalid, idempotency_key_reused, idempotency_in_progress, rate_limited, internal_error.

At a glance#

Request#

Path parameters#

Body#

Response#

Examples#

End a pilot's override#

Errors#