Quote a plan change

Quote a plan change

POST/api/v1/organizations/{id}/workspaces/{workspace_id}/plan-quotes

POST /organizations/{id}/workspaces/{workspace_id}/plan-quotes
curl -X POST 'https://www.unitpost.com/api/v1/organizations/org_123/workspaces/ws_123/plan-quotes' \
  -H 'Authorization: Bearer YOUR_ORG_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
Response · 201
{
  "object": "plan_quote",
  "id": "id_123",
  "workspace_id": "workspace_123",
  "external_id": "external_123",
  "status": "open",
  "kind": "upgrade",
  "current": {
    "plan": "string",
    "tier_index": 0,
    "price_monthly_cents": 0
  },
  "target": {
    "plan": "string",
    "tier_index": 0,
    "price_monthly_cents": 0
  },
  "due_now_cents": 0,
  "carryover_cents": 0,
  "effective": "now",
  "effective_at": "2026-01-01T00:00:00.000Z",
  "expires_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "confirmed_at": "2026-01-01T00:00:00.000Z",
  "hosted_invoice_url": "https://example.com",
  "moves_to_organization": false,
  "pending_change": {
    "plan": "string",
    "tier_index": 0,
    "effective_at": "2026-01-01T00:00:00.000Z"
  },
  "confirm_token": "string"
}

What moving a workspace to plan and tier_index would do; nothing is changed or charged. kind is upgrade (now: the new price is charged in full, the billing period restarts, unused allowance carries over), downgrade (at the end of the period already paid), lateral (now), start (from free: now, on the organization's card), cancel (to free: the plan ends at the period end) or noop. The answer has the prices before and after, due_now_cents, effective_at and a single-use confirm_token, returned only here. A quote lasts 10 minutes. pending_change shows a downgrade already scheduled for the period end; with one, a quote for the current plan and tier is a noop whose confirm cancels it, so the workspace keeps its plan. On a workspace the organization pays for; or on a free workspace that pays for itself, a paid plan is a start billed to the organization (moves_to_organization: true), only while organization billing is on. Within the Owner's API rules: an allowed plan at a price no higher than their largest plan price (with none set, the lowest price of each allowed plan). The key's creator must still be an organization Owner. Takes an organization key (ok_live_…) with organizations:billing.

Parameters2 fields
FieldTypeDescription
idrequiredstring · pathThe organization's id (`org_…`), from `GET /whoami` or Organization → API.
workspace_idrequiredstring · pathThe workspace's id (`ws_…`).
Request body2 fields
FieldTypeDescription
planrequiredstring`free`, or a paid plan the Owner's API rules allow.
tier_indexintegerThe stop on the paid plan's price ladder (default 0, its lowest price). Ignored for `free`.
Response · 201 fields19 fields
FieldTypeDescription
objectrequiredenumplan_quote—
idrequiredstring`pq_…`
workspace_idrequiredstring`ws_…`
external_idrequiredstringThe workspace's `external_id` when quoted.
statusrequiredenumopen | confirmed | expired`open` until confirmed or 10 minutes pass; `confirmed` once a confirm used it.
kindrequiredenumupgrade | downgrade | lateral | start | cancel | noop`upgrade`: now, charged in full, the period restarts, unused allowance carries over. `downgrade`: at the period end. `lateral`: now. `start`: from free, now. `cancel`: to free, at the period end. `noop`: the plan stays as it is; with a `pending_change`, the confirm cancels it (nothing charged).
currentrequiredOrganizationPlanStop—
targetrequiredOrganizationPlanStop—
due_now_centsrequiredintegerCharged to the organization's card on confirm: the new monthly price on an upgrade or a start, else 0 (before any discount). An upgrade restarts the billing period, so usage beyond the old plan's allowance this period, if any, is billed on the same invoice and is not in this number.
carryover_centsrequiredintegerUnused allowance carried into the new period (an upgrade only).
effectiverequiredenumnow | period_end—
effective_atrequiredstringWhen the change takes effect (once confirmed, when it did or will). Null for a `noop`, except one on a plan already set to end, where it is when the plan ends.
expires_atrequiredstring—
created_atrequiredstring—
confirmed_atrequiredstring—
hosted_invoice_urlrequiredstringAfter a confirm from free (`start`): the organization's card was declined or asked for authentication. The plan starts when this invoice is paid; unpaid, it lapses after about 23 hours, nothing is charged and the workspace stays on Free. Null otherwise.
moves_to_organizationrequiredbooleanA free workspace that pays for itself, started on a paid plan billed to the organization: the confirm moves it onto the organization's billing first.
pending_changerequiredobjectA downgrade already scheduled for the end of the period when the quote was made: the plan and stop it moves to, and when. Null when none is scheduled. With one, a quote for the current plan and tier is a `noop` whose confirm cancels it, so the workspace keeps its plan; an upgrade or a lateral move replaces it, another downgrade replaces it, and a cancel to free ends the plan instead.
confirm_tokenstringOn create only: the single-use token the confirm takes (`pqct_…`). Stored hashed; never shown again.
201401403404409422429

Search docs and guides

Search the docs and product guides.