更新订阅商品 - Waffo Pancake

更新订阅商品的内容。如果内容有变化，将自动创建一个新的不可变版本。如果内容与当前版本一致，则不会创建新版本。

POST /v1/actions/subscription-product/update-product

认证方式： API Key

请求体

字段	类型	必需	说明
`id`	string	是	商品 ID（`PROD_xxx` 格式）
`name`	string	否	更新后的商品名称（≤ 64 字符）
`billingPeriod`	string	否	`weekly`、`monthly`、`quarterly` 或 `yearly`
`prices`	object	否	更新后的多币种定价
`description`	string \| null	否	更新后的描述（传 `null` 或 `""` 清空）
`media`	array	否	更新后的媒体
`successUrl`	string \| null	否	更新后的跳转 URL（≤ 512 字符，必须为合法 http(s) URL；传 `null` 或 `""` 清空）
`metadata`	object	否	更新后的元数据（可包含 `trialDays`）

请求示例

const { product } = await client.subscriptionProducts.update({
  id: "PROD_3F7H2J5L8N1Q4S6U",
  name: "Pro Plan v2",
  billingPeriod: BillingPeriod.Monthly,
  prices: {
    USD: { amount: "39.00", taxIncluded: false, taxCategory: TaxCategory.SaaS },
    EUR: { amount: "36.00", taxIncluded: false, taxCategory: TaxCategory.SaaS },
  },
  metadata: { trialDays: 7 },
});

// Uses callApi() helper from authentication.mdx
const result = await callApi("POST", "/v1/actions/subscription-product/update-product", {
  id: "PROD_3F7H2J5L8N1Q4S6U",
  name: "Pro Plan v2",
  billingPeriod: "monthly",
  prices: {
    USD: { amount: "39.00", taxIncluded: false, taxCategory: "saas" },
    EUR: { amount: "36.00", taxIncluded: false, taxCategory: "saas" },
  },
  metadata: { trialDays: 7 },
});
console.log(result.data);

// Uses callApi() helper from authentication.mdx
String body = """
    {"id":"PROD_3F7H2J5L8N1Q4S6U","name":"Pro Plan v2","billingPeriod":"monthly","prices":{"USD":{"amount":"39.00","taxIncluded":false,"taxCategory":"saas"},"EUR":{"amount":"36.00","taxIncluded":false,"taxCategory":"saas"}},"metadata":{"trialDays":7}}""";

String response = callApi("POST", "/v1/actions/subscription-product/update-product", body);
System.out.println(response);

# Uses call_api() helper from authentication.mdx
result = call_api("POST", "/v1/actions/subscription-product/update-product", {
    "id": "PROD_3F7H2J5L8N1Q4S6U",
    "name": "Pro Plan v2",
    "billingPeriod": "monthly",
    "prices": {
        "USD": {"amount": "39.00", "taxIncluded": False, "taxCategory": "saas"},
        "EUR": {"amount": "36.00", "taxIncluded": False, "taxCategory": "saas"},
    },
    "metadata": {"trialDays": 7},
})
print(result["data"])

// Uses callAPI() helper from authentication.mdx
body := map[string]interface{}{
    "id":            "PROD_3F7H2J5L8N1Q4S6U",
    "name":          "Pro Plan v2",
    "billingPeriod": "monthly",
    "prices": map[string]interface{}{
        "USD": map[string]interface{}{"amount": "39.00", "taxIncluded": false, "taxCategory": "saas"},
        "EUR": map[string]interface{}{"amount": "36.00", "taxIncluded": false, "taxCategory": "saas"},
    },
    "metadata": map[string]interface{}{"trialDays": 7},
}
result, err := callAPI("POST", "/v1/actions/subscription-product/update-product", body)
if err != nil {
    log.Fatal(err)
}
fmt.Println(string(result))

// Uses call_api() helper from authentication.mdx
let body = serde_json::json!({
    "id": "PROD_3F7H2J5L8N1Q4S6U",
    "name": "Pro Plan v2",
    "billingPeriod": "monthly",
    "prices": {
        "USD": {"amount": "39.00", "taxIncluded": false, "taxCategory": "saas"},
        "EUR": {"amount": "36.00", "taxIncluded": false, "taxCategory": "saas"}
    },
    "metadata": {"trialDays": 7}
});
let result = call_api("POST", "/v1/actions/subscription-product/update-product", &body).await?;
println!("{}", result);

/* Uses call_api() helper from authentication.mdx */
const char *body = "{\"id\":\"PROD_3F7H2J5L8N1Q4S6U\",\"name\":\"Pro Plan v2\",\"billingPeriod\":\"monthly\",\"prices\":{\"USD\":{\"amount\":\"39.00\",\"taxIncluded\":false,\"taxCategory\":\"saas\"},\"EUR\":{\"amount\":\"36.00\",\"taxIncluded\":false,\"taxCategory\":\"saas\"}},\"metadata\":{\"trialDays\":7}}";
char *response = call_api("POST", "/v1/actions/subscription-product/update-product", body);
printf("%s\n", response);
free(response);

// Uses callApi() helper from authentication.mdx
std::string body = R"({"id":"PROD_3F7H2J5L8N1Q4S6U","name":"Pro Plan v2","billingPeriod":"monthly","prices":{"USD":{"amount":"39.00","taxIncluded":false,"taxCategory":"saas"},"EUR":{"amount":"36.00","taxIncluded":false,"taxCategory":"saas"}},"metadata":{"trialDays":7}})";
std::string response = callApi("POST", "/v1/actions/subscription-product/update-product", body);
std::cout << response << std::endl;

MERCHANT_ID="MER_2aUyqjCzEIiEcYMKj7TZtw"
TIMESTAMP=$(date +%s)
BODY='{
  "id": "PROD_3F7H2J5L8N1Q4S6U",
  "name": "Pro Plan v2",
  "billingPeriod": "monthly",
  "prices": {
    "USD": { "amount": "39.00", "taxIncluded": false, "taxCategory": "saas" },
    "EUR": { "amount": "36.00", "taxIncluded": false, "taxCategory": "saas" }
  },
  "metadata": { "trialDays": 7 }
}'
BODY_HASH=$(echo -n "$BODY" | openssl dgst -sha256 -binary | base64 -w 0)
CANONICAL_REQUEST="POST
/v1/actions/subscription-product/update-product
$TIMESTAMP
$BODY_HASH"

SIGNATURE=$(echo -n "$CANONICAL_REQUEST" | openssl dgst -sha256 -sign private_key.pem | base64 -w 0)

curl -X POST "https://api.waffo.ai/v1/actions/subscription-product/update-product" \
  -H "Content-Type: application/json" \
  -H "X-Merchant-Id: $MERCHANT_ID" \
  -H "X-Timestamp: $TIMESTAMP" \
  -H "X-Signature: $SIGNATURE" \
  -d "$BODY"

MERCHANT_ID="MER_2aUyqjCzEIiEcYMKj7TZtw"
TIMESTAMP=$(date +%s)
BODY='{
  "id": "PROD_3F7H2J5L8N1Q4S6U",
  "name": "Pro Plan v2",
  "billingPeriod": "monthly",
  "prices": {
    "USD": { "amount": "39.00", "taxIncluded": false, "taxCategory": "saas" },
    "EUR": { "amount": "36.00", "taxIncluded": false, "taxCategory": "saas" }
  },
  "metadata": { "trialDays": 7 }
}'
BODY_HASH=$(echo -n "$BODY" | openssl dgst -sha256 -binary | base64 -w 0)
CANONICAL_REQUEST="POST
/v1/actions/subscription-product/update-product
$TIMESTAMP
$BODY_HASH"

SIGNATURE=$(echo -n "$CANONICAL_REQUEST" | openssl dgst -sha256 -sign private_key.pem | base64 -w 0)

wget -qO- "https://api.waffo.ai/v1/actions/subscription-product/update-product" \
  --header="Content-Type: application/json" \
  --header="X-Merchant-Id: $MERCHANT_ID" \
  --header="X-Timestamp: $TIMESTAMP" \
  --header="X-Signature: $SIGNATURE" \
  --post-data="$BODY"

成功响应 (200)

{
  "data": {
    "product": {
      "id": "PROD_3F7H2J5L8N1Q4S6U",
      "storeId": "STO_2D5F8G3H1K4M6N9P",
      "name": "Pro Plan v2",
      "description": null,
      "billingPeriod": "monthly",
      "prices": {
        "USD": { "amount": "39.00", "taxCategory": "saas" },
        "EUR": { "amount": "36.00", "taxCategory": "saas" }
      },
      "media": [],
      "successUrl": null,
      "metadata": { "trialDays": 7 },
      "status": "active",
      "createdAt": "2026-03-30T10:30:00.000Z",
      "updatedAt": "2026-03-30T11:00:00.000Z"
    }
  }
}

响应字段

与创建订阅商品响应相同。

商品更新会创建新的不可变版本。现有订阅保留其原始版本。新注册使用最新版本。如果提交的内容与当前版本一致，则不会创建新版本。

错误响应

重试策略：4xx 一律不要重试 — 修正请求后重发。5xx 指数退避重试（起步 5s，最多 3 次）。

状态码	`errors[0].message`	含义	推荐处理
400	`Missing header: x-context-merchant-id`	商户上下文 header 未透传	修正 SDK 配置
400	`Missing or invalid header: x-context-environment`	环境 header 缺失或不是 `test` / `prod`	把 `X-Environment` 设为 `test` 或 `prod`
400	`Missing required field: id`	请求体缺少 `id`	补齐 `id` 后重发
400	`Expected format: PROD_xxx, got "X"`	`id` 不是合法 Short ID	使用 `PROD_` 前缀的 Short ID
400	`Field name must be a non-empty string`	提供了空字符串的 `name`	不传 `name` 保留原值，或传非空字符串
400	`Invalid billingPeriod`	`billingPeriod` 不在 `weekly` / `monthly` / `quarterly` / `yearly` 集合	改为四个允许值之一
400	`Field prices must be a non-empty object`	传了空 `prices`	不传 `prices` 保留原值，或至少包含一种货币
400	`Invalid currency code: "X". Must be 3 uppercase letters (e.g., "USD", "EUR", "JPY")`	`prices` 的 key 不是合法 ISO 4217 代码	改为 3 位大写字母
400	`Invalid amount for X: "Y". Must be a positive number string (e.g., "9.99", "1000")`	金额字符串无法解析	改为正数十进制字符串
400	消息包含 `has no version`	目标环境（`test` 或 `prod`）尚无版本	先在该环境创建版本（从 test 发布，或在 test 创建）
401	`Unauthorized`	认证失败	检查 API Key、时间戳与签名
404	`Product not found` / `Current version not found`	product ID 不存在（或当前版本缺失）	确认 product ID
500	`Internal server error`	瞬时下游故障	指数退避重试（起步 5s，最多 3 次）

​请求体

​请求示例

​成功响应 (200)

​响应字段

​错误响应

请求体

请求示例

成功响应 (200)

响应字段

错误响应