更新订阅产品的内容。如果内容有变更,会自动创建新的不可变版本。如果内容与当前版本完全相同,则不会创建新版本。
POST /v1/actions/subscription-product/update-product
认证方式: API Key
请求体
| 字段 | 类型 | 必需 | 说明 |
|---|
id | string | 是 | 产品 ID(PROD_xxx 格式) |
name | string | 是 | 更新后的产品名称 |
billingPeriod | string | 是 | weekly、monthly、quarterly 或 yearly |
prices | object | 是 | 更新后的多币种定价 |
description | string | 否 | 更新后的描述 |
media | array | 否 | 更新后的媒体 |
successUrl | string | 否 | 更新后的重定向 URL |
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 },
});
产品更新会创建新的不可变版本。现有订阅保留其原始版本。新注册使用最新版本。如果提交的内容与当前版本完全相同,不会创建新版本。
错误响应
| 状态码 | 条件 |
|---|
400 | 产品没有可比较的现有版本 |
400 | trialDays 不是整数或不在 1-365 范围内 |
404 | 产品未找到 |