Update a subscription product’s content. If content has changed, a new immutable version is created automatically. If the content is identical to the current version, no new version is created.
POST /v1/actions/subscription-product/update-product
認証: API Key
リクエストボディ
フィールド 型 必須 説明 idstring はい 商品 ID(PROD_xxx 形式) namestring はい 更新後の商品名 billingPeriodstring はい weekly、monthly、quarterly、または yearlypricesobject Yes Updated multi-currency pricing descriptionstring いいえ 更新後の説明 mediaarray いいえ 更新後のメディア successUrlstring いいえ 更新後のリダイレクト URL metadataobject いいえ 更新後のメタデータ(trialDays を含む場合があります)
リクエスト例
SDK
TypeScript (fetch)
Java
Python
Go
Rust
C
C++
cURL
wget
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商品に比較対象の既存バージョンがありません 400trialDays が整数でないか、1-365 の範囲外です404商品が見つかりません