The organization object

⚠️

Preview — this feature is being built; the design below is the spec.

The organization object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "org_01J9Z1B3D5F7H9K1M3P5",
  "type": "organization",
  "name": "Acme Store",
  "plan": {
    "name": "Business",
    "status": "active",
    "current_period_end": "2026-12-01T00:00:00Z",
    "monthly_token_allowance": 2000000
  },
  "usage_credits": {
    "enabled": true,
    "balance_usd": "184.2200",
    "monthly_spend_limit_usd": "500.00",
    "auto_reload": {
      "enabled": true,
      "trigger_usd": "20.00",
      "target_usd": "100.00"
    }
  },
  "rate_limit_tier": "2",
  "settings": {
    "zero_data_retention": false,
    "data_retention_days": null,
    "mfa_required": true,
    "sso_enforced": false,
    "default_workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q"
  },
  "member_count": 14,
  "workspace_count": 3,
  "created_at": "2025-04-17T11:20:00Z"
}

Fields

Field	Type	Description
`id`	string	Unique id of this object.
`type`	string	The object type, always `organization`.
`name`	string	Name shown in the Console and in reports.
`plan`	object	Nested detail; see the endpoint pages below.
`usage_credits`	object	Whether credits are on, the balance, the monthly spend limit and auto-reload.
`rate_limit_tier`	string	`start`, `1` to `4`, or `custom`.
`settings`	object	Retention, second-factor and sign-in settings, and the default workspace.
`member_count`	integer	See the endpoint pages below.
`workspace_count`	integer	See the endpoint pages below.
`created_at`	string	When it was created, RFC 3339 UTC (some older objects use Unix seconds).

Returned by

oauth_app plugin

Was this page helpful?