目次

<aside> ⚠️

本APIは今後廃止されます。

「契約周期（プラン）変更」をご利用ください。

</aside>

１．基本情報

指定された契約情報の周期を変更する。

項目名 内容
アクション名 updateSubscriptionLinePlan
リクエストメソッド POST

２．リクエストに必要な内容

項目名 内容 必須 フォーマット 入力例 備考
subscriptionId 定期購買ID はい gid://shopify/SubscriptionContract/*** gid://shopify/SubscriptionContract/1111111111
billingPolicyInterval 変更後の周期単位 はい DAY, WEEK, MONTH, YEARのいずれか MONTH
billingPolicyIntervalCount 変更後の周期数 はい 1以上の数値 3

３．レスポンス内容

周期変更後の契約情報等がJSONデータで返却されます。

■正常時レスポンス

プロパティ 型 説明
originOrderId string null
originOrderToken string null
originOrderName string null
customerDisplayName string null
customerPaymentMethodId number null
subscriptionContractId string 契約情報のShopify管理ID
billingPolicyInterval string 契約情報の決済周期（単位）
billingPolicyIntervalCount number 契約情報の決済周期
billingPolicyMinCycles number null
billingPolicyMaxCycles number null
status string 契約情報のステータス（ACTIVE、PAUSED、CANNCELLED）
deliveryPriceAmount number null
deliveryPriceCurrencyCode string 契約情報の決済時配送料金通貨
deliveryAddress1 string null
deliveryAddress2 string null
deliveryCity string null
deliveryCompany string null
deliveryCountry string null
deliveryCountryCode string null
deliveryFirstName string null
deliveryLastName string null
deliveryName string null
deliveryPhone string null
deliveryProvince string null

■異常時レスポンス

| --- | --- | --- |