Get a plan quote
GET/api/v1/organizations/{id}/workspaces/{workspace_id}/plan-quotes/{quote_id}
GET /organizations/{id}/workspaces/{workspace_id}/plan-quotes/{quote_id}
curl -X GET 'https://www.unitpost.com/api/v1/organizations/org_123/workspaces/ws_123/plan-quotes/pq_123' \
-H 'Authorization: Bearer YOUR_ORG_KEY' \
-H 'User-Agent: my-app/1.0'Response · 200
{
"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"
}A plan quote as it was offered, with its status (open, confirmed, expired) and, once confirmed, confirmed_at and hosted_invoice_url. Never the confirm token. Takes an organization key (ok_live_…) with organizations:read.
Parameters3 fields
| Field | Type | Description |
|---|---|---|
idrequired | string · path | The organization's id (`org_…`), from `GET /whoami` or Organization → API. |
workspace_idrequired | string · path | The workspace's id (`ws_…`). |
quote_idrequired | string · path | The plan quote's id (`pq_…`). |
Response · 200 fields19 fields
| Field | Type | Description |
|---|---|---|
objectrequired | enumplan_quote | — |
idrequired | string | `pq_…` |
workspace_idrequired | string | `ws_…` |
external_idrequired | string | The workspace's `external_id` when quoted. |
statusrequired | enumopen | confirmed | expired | `open` until confirmed or 10 minutes pass; `confirmed` once a confirm used it. |
kindrequired | enumupgrade | 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). |
currentrequired | OrganizationPlanStop | — |
targetrequired | OrganizationPlanStop | — |
due_now_centsrequired | integer | Charged 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_centsrequired | integer | Unused allowance carried into the new period (an upgrade only). |
effectiverequired | enumnow | period_end | — |
effective_atrequired | string | When 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_atrequired | string | — |
created_atrequired | string | — |
confirmed_atrequired | string | — |
hosted_invoice_urlrequired | string | After 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_organizationrequired | boolean | A 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_changerequired | object | A 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_token | string | On create only: the single-use token the confirm takes (`pqct_…`). Stored hashed; never shown again. |
200401403404429