目次

• 概要

  • はじめに
  • 開発に必要な技術
  • GCP環境の提供
  • 開発ソースコード提供
  • 開発手順
  • 本番環境への反映方法

• APIリファレンス

  • 共通仕様
  • トークン情報取得
  • 商品追加
  • 商品変更
  • 商品一括変更
  • 商品削除
  • 商品数量変更
  • 契約周期（プラン）変更
  • 商品販売可能確認
  • 変更可能商品取得
  • 解約理由取得
  • 決済情報取得
  • プラングループ取得
  • プラングループ取得（商品別）
  • レコメンド商品取得
  • 定期購買契約一覧取得
  • 定期購買契約詳細取得
  • 定期購買契約内の契約商品に紐づくプラン取得
  • 今すぐ注文
  • 決済方法の更新
  • 次回決済のスキップ
  • 次回決済のスキップ取消
  • 配送先住所変更
  • お届け日変更
  • 契約ステータス変更
  • マイページクーポン適用

１．基本情報

指定された定期購買IDの決済情報を取得する。

※1 定期購買アプリではクレジットカード番号全ては管理しておりません。下4桁のみの返却となります。

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

３．レスポンス内容

■正常時レスポンス

下記のいずれか ・CustomerCreaditCard ・CustomerPaypalBillingAgreement ・CustomerShopPayAgreement | | L brand | string | null | クレカブランド名 | | L lastDigits | string | null | クレカ番号の末尾4桁 | | L maskedNumber | string | null | 末尾4桁の前がマスクされたクレカ番号 | | L name | string | null | クレカ名義 | | L expiryMonth | number | null | 有効期限(月） | | L expiryYear | number | null | 有効期限(年） | | L inactive | boolean | null | 無効フラグ | | L paypalAcountEmail | string | null | Paypalメールアドレス |

※ 決済方法によって返却されるレスポンスが異なります。

■参考情報（Shopifyにおける支払い方法の取り扱いについて）

https://help.shopify.com/ja/manual/products/purchase-options/subscriptions/setup

（１）Shopify Payment（クレジットカード）による支払いの場合

上記の通り、下4桁のカード番号に加え、期限や名前などの情報が返却されます。

（Google Payはクレジットカードと同じ取り扱いとなるため、上記と同じく返却されます）

（２）Shopify Payment（クレジットカード）以外の支払いの場合

• Shop Pay
• PayPal Express

など

4．補足情報

■返却パターン

（１）クレジットカード(type=CustomerCreaditCard)の場合、以下のプロパティに値が入る

• brand
• lastDigits
• maskedNumber
• name
• expiryMonth
• expiryYear

（2）Paypal(type=CustomerPaypalBillingAgreement)の場合、以下のプロパティに値が入る

• inactive
• paypalAccountEmail

（3）ShopPay(type=CustomerShopPayAgreement)の場合、以下のプロパティに値が入る

• expiryMonth
• expiryYear
• inactive

（4）customerPaymentMethod = null または、customerPaymentMethod.type = null

※既存の支払い方法に対して、同期バッチを実施した際に、Shopifyのデータを取得できなかったデータとなります