latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Workspace

Plan Details

Lists details of the workspace's current plan and usage

get/api/v1/workspaces/plan_details

Query parameters

workspace_idinteger required

ID of the workspace.

Example:123456

Response

Successful Response

current_member_countinteger required

Current number of active workspace members.

current_plan'Business' | 'Starter' required

Current workspace plan.

current_plan_status'Active' | 'Downgraded' | 'Cancelled' | 'NeverSubscribed' required

Current workspace plan status.

downgrade_atstring nullable required

Date when the workspace downgrades, or null if not scheduled.

current_active_projectsinteger required

Current number of active workspace projects.

maximum_active_projectsinteger required

Maximum number of active projects allowed by the plan.

workspace_idinteger required

ID of the workspace.

is_trialingboolean required

Whether the workspace is currently trialing a paid plan.

trial_ends_atstring nullable required

Date when the current trial ends, or null if not trialing.

cancel_at_period_endboolean required

Whether the plan cancels at the end of the billing period.

has_trialedboolean required

Whether the workspace has already used a trial.

has_billing_portalboolean required

Whether a billing portal is available for the workspace.

has_billing_portal_switch_to_annualboolean required

Whether the billing portal can switch the subscription to annual billing.

Example response

{
  "current_member_count": 10,
  "current_plan": "Business",
  "current_plan_status": "Active",
  "current_active_projects": 12,
  "maximum_active_projects": 500,
  "price_list": [
    {
      "billing_cycle": "monthly",
      "prices": [
        {
          "currency": "USD",
          "tax_behavior": "exclusive",
          "unit_amount": 600
        }
      ]
    }
  ],
  "workspace_id": 123456,
  "has_trialed": true,
  "plan_price": {
    "amount": "600",
    "raw_amount": 600,
    "currency": "USD",
    "billing_cycle": "monthly",
    "tax_behavior": "exclusive"
  },
  "has_billing_portal": true
}