目次

1.基本情報


契約の決済日を指定された回数分スキップする。

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

2.リクエストに必要な内容


項目名 内容 必須 フォーマット 入力例 備考
subscriptionId 定期購買ID はい gid://shopify/SubscriptionContract/*** gid://shopify/SubscriptionContract/123456789
skipCount 5 はい 1以上の数値 1
skipDate 現在の次回お届け日 はい 文字列 2024年8月21日 FlowトリガーのskipDateとして設定したい日付

3.レスポンス内容


スキップ後の決済日、お届け日等の情報が返却されます。

■正常時レスポンス

プロパティ 説明
nextBillingDate timestamp 次回決済日時(UTC)
subscriptionHistories array() スキップ履歴(今回分)
L id number 定期購買アプリ内のスキップ履歴管理ID
L applicationId number 定期購買アプリ内での定期購買契約管理ID
L status string SKIPPED固定
L createdAt timestamp スキップ日
L updatedAt timestamp スキップ更新日
L canceledAt timestamp スキップキャンセル日
L skipCount number スキップ回数
nextDeliveryDate timestamp 次回お届け日(UTC)

■異常時レスポンス

ステータスコード エラーメッセージ
400 string この定期購買の契約種別では許可されていない操作です
400 string 定期購買はすでに解約されています
400 string 最低支払い回数以下のため操作を受け付けられませんでした
404 string 定期購買が存在しません
404 string ストアが存在しません
404 string 顧客が存在しません
409 string 現在決済処理中のため、しばらく時間をおいてからお試しください
500 string 内部エラーが発生しています