account

Subaccount policy updates

Authenticated subaccount policy configuration updates for one root account.

Transport

WebSocket

Encoding

Protobuf

Visibility

Authentication required

Channel

private:auth:subaccount-policies:{rootAccountPublicId}:proto

Subscribe frame

{
  "type": "subscribe",
  "channel": "private:auth:subaccount-policies:3gDmDv6tjHJ:proto"
}

Channel parameters

rootAccountPublicId string

Public root account identifier authorized by the subscription token.

e.g. 3gDmDv6tjHJ

Message

Payload auth.v1.SubaccountPolicyView

id string (fixed64)

Policy identifier (opaque ID).

Example 3458764513820540929

name string

Human-readable policy name.

Example Trader limits

description string

Optional policy description for dashboards and audits.

1 field

spotMarketScope enum must be defined value

Market-level scope for spot markets. When ALL, spot_markets is returned for display only and is not enforced.

ALL ALLOWLIST

actions enum[] max 64 items, unique

Effective high-level actions enabled for the sub-account. Mandatory read-only actions are always included.

TRADE_SPOT INTERNAL_TRANSFER EXTERNAL_WITHDRAW READ_BALANCES READ_SPOT READ_INTERNAL_TRANSFERS READ_ADDRESS_BOOK MANAGE_ADDRESS_BOOK READ_AUTO_WITHDRAW MANAGE_AUTO_WITHDRAW SWAP

isTemplate boolean

True if this policy is a reusable template; false if it is a per-sub-account instance.

sourceTemplateId string (fixed64)

Optional source template this policy was copied from (opaque ID). This is audit metadata only and does not imply live linkage.

maxOrderNotional string (uint64)

Maximum notional size allowed for any single order on this sub-account, expressed in canonical quote microunits (one unit is 0.000001 USDT). A value of 0 means "no explicit cap".

maxOpenOrders integer (int32)

Maximum number of resting orders allowed on this sub-account at any time. A value of 0 means "no explicit cap".

tradingHalted boolean

When true, new orders and exposure-increasing order or trigger changes are rejected regardless of other settings. Existing orders and triggers may still be canceled or paused by an otherwise authorized caller.

locked boolean

When true, this policy is write-protected and requires an elevated approval flow to modify it.

reviewAt string (date-time)

Optional review time in UTC. This is governance metadata and does not automatically disable the policy.

expiresAt string (date-time)

Optional expiry time in UTC. This is governance metadata and does not automatically disable the policy.

createdAt string (date-time)

Creation time in UTC.

updatedAt string (date-time)

Last update time in UTC.

revision string (uint64)

Monotonic resource revision used for conditional updates.