Preview an organization ownership transfer

POST

/v1/admin/orgs/{org_id}/ownership-handoffs/preview

• Production
• Local

Current source owner only. Supports one standalone root organization, not a child or subtree. Returns bounded inventory and financial terms without offering access or charging the recipient. Requires a verified human Clerk session. Agent keys and delegated connections, including Full account control, are rejected.

Authorizations

• ClerkSession

Parameters

Path Parameters

org_id

required

string

Request Body ^required

object

recipient_email

required

string format: email

<= 254 characters

Responses

200

Success.

object

manifest

required

object

org_name

required

string

domain_count

required

integer

member_count

required

integer

credential_count

required

integer

digest

required

Opaque inventory and authority snapshot digest.

string

customer_id

required

string

org_id

required

string

mailboxes

required

Array<object>

<= 100 items

object

id

required

string

address

required

string

blockers

required

Reasons this inventory cannot be offered for transfer.

Array<string>

billing

required

object

digest

required

Opaque digest binding the exact financial terms.

string

terms

required

object

policy_version

required

integer

Allowed values: 1

org_id

required

string

plan_tier

required

string

Allowed values: free developer startup

refunds

required

boolean

backdated_charges

required

boolean

historical_bills_and_credits

required

string

Allowed values: former_payer

subscriptions

required

Array<object>

<= 101 items

object

kind

required

string

Allowed values: plan domain

resource_id

required

string

name

required

string

source_subscription_id

required

string

price_id

required

string

quantity

required

integer format: int64

currency

required

string

Allowed values: usd

unit_amount

required

Price per unit in integer minor currency units.

integer format: int64

interval

required

string

Allowed values: month year

interval_count

required

integer format: int64

Allowed values: 1

paid_through

required

Existing paid-through date in Unix seconds. No transfer charge for this remaining paid time.

integer format: int64

auto_renew

required

Whether future renewal remains enabled; transferring does not turn renewal on.

boolean

400

Invalid request.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string

used

Consumed plus reserved units.

integer format: int64

delta

Requested additional units.

integer format: int64

limit

integer format: int64

remaining

integer format: int64

consumed

integer format: int64

reserved

integer format: int64

next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time

upgrade_required

boolean

401

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string

used

Consumed plus reserved units.

integer format: int64

delta

Requested additional units.

integer format: int64

limit

integer format: int64

remaining

integer format: int64

consumed

integer format: int64

reserved

integer format: int64

next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time

upgrade_required

boolean

403

Authenticated but lacking the required scope, or out of quota.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string

used

Consumed plus reserved units.

integer format: int64

delta

Requested additional units.

integer format: int64

limit

integer format: int64

remaining

integer format: int64

consumed

integer format: int64

reserved

integer format: int64

next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time

upgrade_required

boolean

404

Resource not found.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string

used

Consumed plus reserved units.

integer format: int64

delta

Requested additional units.

integer format: int64

limit

integer format: int64

remaining

integer format: int64

consumed

integer format: int64

reserved

integer format: int64

next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time

upgrade_required

boolean

409

Current state

503

Ownership or billing service unavailable.