跳转到主要内容
PATCH
Update a product
请使用属于该产品所在组织、且为全部权限或勾选了 products:products:write 权限(控制台中“可创建和修改”下的产品)的 API 密钥进行认证。只有 Owner 和 Admin 角色可以授予该权限。
  • id 是你组织内的产品 ID,无论该产品是通过 API 还是在控制台创建的。
  • 请求体包含 name 和 description,均为可选。只有你传入的字段会被修改。
  • 响应结构与读取产品相同。
  • 未知字段会被拒绝,返回 400。该接口没有 Idempotency-Key。
银行卡结账页显示的是产品的名称和描述,因此修改后,所有已有支付链接的结账页会立即显示新内容。支付链接自己的标题显示在付款成功页上;如需修改,请使用更新支付链接。

授权

X-API-Key
string
header
必填

Merchant API key (format: ak_BASE64)

路径参数

id
string
必填

Product ID

请求体

application/json

Fields to change

name
string

New product name

Maximum string length: 255
description
string

New product description

Maximum string length: 2000

响应

OK

data
object
error
object
message
string
success
boolean