次回決済のスキップ取消
1.基本情報
直前のスキップ処理を取り消しする。
取り消し後の次回決済日が過去日となる場合は取消不可となります。
項目名 | 内容 |
---|---|
アクション名 | skipCancelSubscription |
リクエストメソッド | POST |
2.リクエストに必要な内容
項目名 | 内容 | 必須 | フォーマット | 入力例 | 備考 |
---|---|---|---|---|---|
subscriptionId | 定期購買ID | はい | gid://shopify/SubscriptionContract/*** | gid://shopify/SubscriptionContract/123456789 | |
skipCancelDate | キャンセル日 | はい | 文字列 | 2024年1月1日 | 当日(Shopify Flowのトリガー上のスキップ取消日はこの値が参照されます) |
3.レスポンス内容
スキップ取り消し後の次回決済日やお届け日が返却されます。
■正常時レスポンス
プロパティ | 型 | 説明 |
---|---|---|
nextBillingDate | timestamp | 次回決済日時(UTC) |
nextDeliveryDate | timestamp | 次回お届け日(UTC) |
subscriptionHistories | array() | スキップ履歴(今回分) |
L status | string | SKIPPED固定 |
L createdAt | timestamp | スキップ日 |
L canceledAt | timestamp | スキップキャンセル日 |
L skipCount | number | スキップ回数 |
■異常時レスポンス
ステータスコード | 型 | エラーメッセージ |
---|---|---|
400 | string | この定期購買の契約種別では許可されていない操作です |
400 | string | 定期購買はすでに解約されています |
400 | string | スキップキャンセル可能日を過ぎています |
404 | string | 定期購買が存在しません |
404 | string | ストアが存在しません |
404 | string | 顧客が存在しません |
404 | string | 取消可能なスキップが存在しません |
409 | string | 現在決済処理中のため、しばらく時間をおいてからお試しください |
500 | string | 内部エラーが発生しています |