Skip to main content
The organization’s plan, what it includes, its limits and this month’s usage, and the other organizations on the same account. See Plans and limits for what each plan includes.

GET plan/

Every member can read it. license_key is only included for callers with org.manage_settings.
  • A null limit means unlimited.
  • limits_base lists only the limits your account has raised above the plan, with the plan’s own value. Here the plan includes 3 runners and the account added 2.
  • tone is neutral under 80% of the limit, warning from 80%, and danger at the limit.
  • ending is null unless the plan is about to end. reason is payment_failed (the plan stays while payment is retried; next_retry_at says when), cancel_scheduled (ends at ends_at, the end of the paid period) or license_expiring (a contract ending within 30 days).
  • active: false means the plan has lapsed. license_phase is active, grace (full access for 7 days after expires_at), restricted (read-only until suspends_at) or suspended. See When a plan ends.
  • plan: null means the organization has no account (only staff-created test orgs).

GET account/organizations/

Organizations that share this organization’s account. Needs org.manage_settings.

POST account/organizations/

{"name": "Acme EU"}. Owners and admins of an organization on a Business (up to 3 organizations) or Enterprise (unlimited) account can use it. The caller becomes the new organization’s owner. 201 with {"organization": {...}}, 409 with code: "plan_limit_reached" when the account is full or the plan allows one organization, and 403 for members.

Plan errors elsewhere