Version
DESTRUCTIVE

revoke_access_code

Revoke one unredeemed access code so it can no longer be redeemed. Destructive, idempotent.

Revoke a pending code, the operation DELETE /v1/projects/{project}/plans/{plan}/access-codes/{accessCode} performs: the code stops appearing in list_access_codes and can never be redeemed. The answer carries the id with "revoked": true.

Only a pending code can be revoked

A code somebody already redeemed became a subscription: it surfaces here as RESOURCE_NOT_FOUND, and ending that member's access is cancel_subscription's job, never a revoke.

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

DestructiveIdempotent

A client that honours annotations asks a person before running it. Sending the same arguments twice changes nothing the second time.

Arguments

plan_id*string

UUID of the plan the code belongs to.

access_code_id*string

UUID of the unredeemed code, from `list_access_codes`.

How it fails

RESOURCE_NOT_FOUND

the plan or code is unknown, foreign, or the code was already redeemed.

TOKEN_MISSING_ABILITY

token lacks project-access-code:delete.

Arguments

  • plan_id (required) — UUID of the plan the code belongs to.
  • access_code_id (required) — UUID of the unredeemed code, from list_access_codes.

How is this guide?

Last updated on