概要
APIリファレンス
契約の決済日を指定された回数分スキップする。
| 項目名 | 内容 |
|---|---|
| アクション名 | skipSubscription |
| リクエストメソッド | POST |
| 項目名 | 内容 | 必須 | フォーマット | 入力例 | 備考 |
|---|---|---|---|---|---|
| subscriptionId | 定期購買ID | はい | gid://shopify/SubscriptionContract/*** | gid://shopify/SubscriptionContract/123456789 | |
| skipCount | 5 | はい | 1以上の数値 | 1 | |
| skipDate | 現在の次回お届け日 | はい | 文字列 | 2024年8月21日 | FlowトリガーのskipDateとして設定したい日付 |
スキップ後の決済日、お届け日等の情報が返却されます。
■正常時レスポンス
| プロパティ | 型 | 説明 |
|---|---|---|
| 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) |
■異常時レスポンス
| --- | --- | --- |