Get the shared plan

Get the shared plan

GET/api/v1/organizations/{id}/shared-plan

GET /organizations/{id}/shared-plan
curl -X GET 'https://www.unitpost.com/api/v1/organizations/org_123/shared-plan' \
  -H 'Authorization: Bearer YOUR_ORG_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "shared_plan",
  "approved": false,
  "requested_at": "2026-01-01T00:00:00.000Z",
  "status": "none",
  "plan": "string",
  "tier_index": 0,
  "price_monthly_cents": 0,
  "period_start": "2026-01-01T00:00:00.000Z",
  "period_end": "2026-01-01T00:00:00.000Z",
  "cancel_at": "2026-01-01T00:00:00.000Z",
  "allowance_cents": 0,
  "used_cents": 0,
  "overage_cents": 0,
  "overage_cap_cents": 0,
  "paused": false,
  "overage_frozen": false,
  "workspace_limit": 1,
  "workspaces": 0
}

The organization's shared plan: one plan whose allowance its workspaces share. approved says whether Unitpost's team turned it on for the organization (it is never on by default: an Owner or Billing member asks on Organization → Billing, requested_at). status is none until a plan is bought there, then the plan's status. With a plan: its plan, tier_index and list price_monthly_cents, the billing period, cancel_at (set to end at the period end), the shared allowance_cents, what its workspaces drew this period (used_cents, overage_cents beyond the allowance), the overage band's size (overage_cap_cents, null for no band), paused (the allowance and band are used up: every workspace on it stops sending until the period renews), overage_frozen (Unitpost paused overage: sending stops at the allowance) and how many workspaces it covers (workspace_limit) and has (workspaces). Buying, upgrading and ending the plan, and raising its workspace number, are done in the dashboard. Takes an organization key (ok_live_…) with organizations:read.

Parameters1 field
FieldTypeDescription
idrequiredstring · pathThe organization's id (`org_…`), from `GET /whoami` or Organization → API.
Response · 200 fields18 fields
FieldTypeDescription
objectrequiredenumshared_plan—
approvedrequiredbooleanUnitpost's team turned the shared plan on for the organization; it is never on by default.
requested_atrequiredstringWhen an Owner or Billing member asked for it (Organization → Billing); null if nobody has.
statusrequiredenumnone | active | trialing | past_due | paused | canceled`none` until a plan is bought; then the plan's status. `past_due` keeps its workspaces but takes no new ones; `canceled` once it ended (its workspaces left it).
planrequiredstringThe plan's key (`pro` is Starter, `scale` is Growth); null with none.
tier_indexrequiredintegerThe stop on the plan's price ladder.
price_monthly_centsrequiredintegerThe stop's list price a month, before any discount or promotion code.
period_startrequiredstring—
period_endrequiredstring—
cancel_atrequiredstringSet to end then (the period end); null while it renews.
allowance_centsrequiredintegerThe allowance its workspaces share each period, in cents of sending (email, SMS, WhatsApp).
used_centsrequiredintegerWhat its workspaces drew this period, including workspaces that left during it. 0 with no plan.
overage_centsrequiredintegerThe part of `used_cents` beyond the allowance, billed at the plan's overage rate.
overage_cap_centsrequiredintegerThe overage band: how far past the allowance its workspaces may send in a period. Null: no band.
pausedrequiredbooleanThe allowance and the band are used up (only the allowance while `overage_frozen`): every workspace on the plan stops sending until the period renews or the plan is upgraded.
overage_frozenrequiredbooleanUnitpost's team paused overage on the plan (a disputed charge): sending stops at the allowance.
workspace_limitrequiredintegerHow many workspaces the plan covers (Starter 3, Growth 10, unless Unitpost's team set another number). Before a plan is bought, the number set for the organization, or null for the plan's own.
workspacesrequiredintegerHow many workspaces are on it now.
200401403404429

Search docs and guides

Search the docs and product guides.