方法路径摘要认证
GET/v1/admin/account/order-usersSearch active users for order entry登录会话
POST/v1/admin/account/ordersEnter an audited compatibility order record登录会话
PATCH/v1/admin/account/orders/{id}Edit an audited compatibility order record登录会话
DELETE/v1/admin/account/orders/{id}Archive an audited compatibility order record登录会话

契约文件:api/control-account-orders.openapi.yaml

接口详情

GET /v1/admin/account/order-users

Search active users for order entry

operationId
listAccountOrderUsers
认证
  • 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码,权限要求见下方说明与 403 响应。

说明(契约原文)

Platform administrators only (billing.adjustments.manage); searches active tenant users for order entry.

参数

listAccountOrderUsers 参数
名称位置类型必填说明
searchquerystring否—
limitqueryinteger否—

响应

listAccountOrderUsers 响应
状态码说明
200Matching active users

字段:items: array<AccountOrderUser>

400Invalid request fields
401Authentication is required
403Required permission is absent
503Account order service unavailable

失败时怎么办

  • 400 按字段说明修正参数或请求体再发;不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 503 依赖暂不可用:稍后用原 Idempotency-Key 重试。

↑ 回到列表

POST /v1/admin/account/orders

Enter an audited compatibility order record

operationId
createAccountOrder
认证
  • 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码,权限要求见下方说明与 403 响应。

说明(契约原文)

Platform administrators only (live platform session with billing.adjustments.manage); tenants have no order-record write API (r136 tp-b5b). This does not mutate package, recharge, payment, or balance-ledger facts.

参数

createAccountOrder 参数
名称位置类型必填说明
Idempotency-Keyheaderstring是—

请求体

application/json · 必填:是

createAccountOrder 请求体
名称类型必填说明
user_idstring(uuid)是—
typestring: recharge / deduction / upgrade / purchase / renewal / package_change是—
notestring是—
original_amount_minorinteger是—
paid_amount_minorinteger是—
payment_methodstring是—
merchant_order_numberstring是—
transaction_numberstring是—
statusstring: paid / unpaid是—
created_atstring(date-time)是—
paid_atstring(date-time) | null是—

响应

createAccountOrder 响应
状态码说明
201Created record

字段:id: string(uuid) display_id: string tenant_scope_id: string(uuid) tenant_id: string(uuid) user_id: string(uuid) user_display_id: string username: string user_display_name: string source: string: manual / package / recharge type: string: recharge / deduction / upgrade / purchase / renewal / package_change note: string original_amount_minor: integer paid_amount_minor: integer details: string payment_method: string merchant_order_number: string transaction_number: string status: string: paid / unpaid created_at: string(date-time) paid_at?: string(date-time) revision: integer editable: boolean

400Invalid request fields
401Authentication is required
403Required permission is absent
409Revision or idempotency conflict
415Content-Type must be application/json
503Account order service unavailable

失败时怎么办

  • 400 按字段说明修正参数或请求体再发;不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。
  • 503 依赖暂不可用:稍后用原 Idempotency-Key 重试。

↑ 回到列表

PATCH /v1/admin/account/orders/{id}

Edit an audited compatibility order record

operationId
updateAccountOrder
认证
  • 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码,权限要求见下方说明与 403 响应。

说明(契约原文)

Platform administrators only (billing.adjustments.manage). Only records whose source is manual are editable. Package and recharge facts remain immutable.

参数

updateAccountOrder 参数
名称位置类型必填说明
idpathstring(uuid)是—
Idempotency-Keyheaderstring是—
If-Matchheaderstring是—

请求体

application/json · 必填:是

updateAccountOrder 请求体
名称类型必填说明
user_idstring(uuid)是—
typestring: recharge / deduction / upgrade / purchase / renewal / package_change是—
notestring是—
original_amount_minorinteger是—
paid_amount_minorinteger是—
payment_methodstring是—
merchant_order_numberstring是—
transaction_numberstring是—
statusstring: paid / unpaid是—
created_atstring(date-time)是—
paid_atstring(date-time) | null是—

响应

updateAccountOrder 响应
状态码说明
200Updated record

字段:id: string(uuid) display_id: string tenant_scope_id: string(uuid) tenant_id: string(uuid) user_id: string(uuid) user_display_id: string username: string user_display_name: string source: string: manual / package / recharge type: string: recharge / deduction / upgrade / purchase / renewal / package_change note: string original_amount_minor: integer paid_amount_minor: integer details: string payment_method: string merchant_order_number: string transaction_number: string status: string: paid / unpaid created_at: string(date-time) paid_at?: string(date-time) revision: integer editable: boolean

400Invalid request fields
401Authentication is required
403Required permission is absent
404Record not found
409Revision or idempotency conflict
415Content-Type must be application/json
503Account order service unavailable

失败时怎么办

  • 400 按字段说明修正参数或请求体再发;不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。
  • 409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。
  • 503 依赖暂不可用:稍后用原 Idempotency-Key 重试。

↑ 回到列表

DELETE /v1/admin/account/orders/{id}

Archive an audited compatibility order record

operationId
deleteAccountOrder
认证
  • 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码,权限要求见下方说明与 403 响应。

说明(契约原文)

Archives the editable head while retaining its append-only event, receipt, and audit facts.

参数

deleteAccountOrder 参数
名称位置类型必填说明
idpathstring(uuid)是—
Idempotency-Keyheaderstring是—
If-Matchheaderstring是—

响应

deleteAccountOrder 响应
状态码说明
200Archived record

字段:id: string(uuid) display_id: string tenant_scope_id: string(uuid) tenant_id: string(uuid) user_id: string(uuid) user_display_id: string username: string user_display_name: string source: string: manual / package / recharge type: string: recharge / deduction / upgrade / purchase / renewal / package_change note: string original_amount_minor: integer paid_amount_minor: integer details: string payment_method: string merchant_order_number: string transaction_number: string status: string: paid / unpaid created_at: string(date-time) paid_at?: string(date-time) revision: integer editable: boolean

400Invalid request fields
401Authentication is required
403Required permission is absent
404Record not found
409Revision or idempotency conflict
503Account order service unavailable

失败时怎么办

  • 400 按字段说明修正参数或请求体再发;不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。
  • 409 先回读资源当前状态;同一操作重试保持原 Idempotency-Key 和原请求内容。
  • 503 依赖暂不可用:稍后用原 Idempotency-Key 重试。

↑ 回到列表