plan

Redeem a complimentary-access grant code for the active organization

Requires the manage scope (a session is always manage-scoped). A code minted by POST /v1/admin/plan-grants sets plan, plan_source='complimentary', plan_note and — if the grant has a plan_duration_days — plan_expires_at. A paying org (plan_source='billing') cannot redeem (409 plan_is_billing: cancel the subscription first); redeeming a lower tier than the org's current plan is refused (409 plan_not_upgrade).

post/v1/plan/redeem

Request

  • Base URL: https://postbag.dev
  • URL: https://postbag.dev/v1/plan/redeem
  • Auth: HTTP bearer

Request body

codestring required

A code minted by POST /v1/admin/plan-grants.

Response

ok

plan'free' | 'pro' | 'team' | 'selfhost' required
plan_source'free' | 'billing' | 'complimentary' | 'selfhost' required
plan_expires_atstring nullable required
plan_notestring nullable required

Example response

{
  "plan_expires_at": "2026-08-21T09:00:00.000Z"
}

Changes

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