admin

Revoke a plan grant so it can no longer be redeemed (platform admin only)

Platform-admin only: allowed when the caller's email (the session user's email, or — for an API key — the owner member's email of the key's organization) is in the server's PLATFORM_ADMIN_EMAILS env var (comma-separated, empty by default). Any other caller gets 404 not_found, not 403, so a self-hosted operator who never sets PLATFORM_ADMIN_EMAILS never sees this endpoint exist. Idempotent — revoking an already-revoked grant just returns it.

post/v1/admin/plan-grants/{id}/revoke

Request

  • Base URL: https://postbag.dev
  • URL: https://postbag.dev/v1/admin/plan-grants/{id}/revoke
  • Auth: HTTP bearer

Path parameters

idstring required
Example:fm_8f3kq2

Response

ok

idstring required
plan'free' | 'pro' | 'team' | 'selfhost' required
notestring nullable required
expires_atstring nullable required
plan_duration_daysinteger nullable required
max_redemptionsinteger required
redeemed_countinteger required
created_by_user_idstring required
created_atstring required
revoked_atstring nullable required

Example response

{
  "id": "fm_8f3kq2",
  "expires_at": "2026-08-21T09:00:00.000Z",
  "created_at": "2026-08-21T09:00:00.000Z",
  "revoked_at": "2026-08-21T09:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.