Skip to main content

Upgrade the pricing tier of a root organization​

Moves the given root organization to a higher pricing tier and records the calling super-admin as the actor of the change. Only upgrades are accepted, along one of two branches: free-trial -> professional -> enterprise -> enterprise-with-nhi, or free-trial -> identity-protection. A tier can be moved to any later tier of its branch in one step; the branches never join and are never walked backwards. Asking for the organization's current tier changes nothing and succeeds. The change is replicated to every region. Fails with 400 for the dashboard organization and for a sub-organization, whose pricing tier is the one of its root organization, and with 409 when the target tier is not an upgrade of the current one.

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Request Body required
  • organization_id string required

    The root organization to upgrade

  • pricing_tier string required

    Possible values: [free-trial, professional, enterprise, enterprise-with-nhi, identity-protection]

    The tier associated with a root organization.

    Your organization may be subject to various constraints depending on its tier, such as maximum number of users, rate-limits, etc.

Responses

Pricing tier upgraded

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • errors object[]
  • httpcode integer
  • message string
  • code string

    Machine-readable reason, present only for errors that define one. Values today: unserved_org_region (the organization is homed in a region this deployment does not serve), wrong_region (the request must be sent to the organization's home region), region_route_missing (this instance has no route to the organization's home region).

  • result object
  • organization_id string
  • pricing_tier string

    Possible values: [free-trial, professional, enterprise, enterprise-with-nhi, identity-protection]

    The tier associated with a root organization.

    Your organization may be subject to various constraints depending on its tier, such as maximum number of users, rate-limits, etc.