ResultCustomerSubscriptionContract

顧客向け契約情報

type ResultCustomerSubscriptionContract {
  isSyncingSubscription: Boolean!
  isManualPaymentMethod: Boolean!
  createdAt: String!
  contractType: ContractType!
  status: SubscriptionStatus!
  nextBillingDate: String!
  deliveryDays: Int!
  deliveryTime: String
  billingPolicyInterval: BillingPolicyInterval!
  billingPolicyIntervalCount: Int!
  billingPolicyMinCycles: Int
  billingPolicyMaxCycles: Int
  deliveryCountry: String
  deliveryCountryCode: String
  deliveryProvince: String
  deliveryProvinceCode: String
  deliveryZip: String
  deliveryCity: String
  deliveryAddress1: String
  deliveryAddress2: String
  deliveryFirstName: String
  deliveryLastName: String
  deliveryName: String
  deliveryPhone: String
  deliveryCompany: String
  deliveryPriceAmount: Float
  deliveryPriceCurrencyCode: String
  excludeFromAutoCalculateDeliveryPrice: Boolean!
  customerDisplayName: String!
  originOrderId: String
  originOrderName: String
  originOrderToken: String
  note: String
  bulkPayCount: Int
  bulkPayMinCycleCount: Int
  nextDeliveryDate: String!
  deliveryTimeText: String!
  totalOrderCount: Int!
  bulkPayNextBillingDate: String
  bulkPayCancellableBeginDate: String
  bulkPayCancellableEndDate: String
  canSkipCancel: Boolean!
  startSyncSubscriptionDate: String
  rank: CustomerSubscriptionContractRank
  customerPaymentMethod: CustomerSubscriptionContractPaymentMethod
  subscriptionDiscounts: [CustomerSubscriptionContractSubscriptionDiscount]!
  subscriptionLines: [CustomerSubscriptionContractSubscriptionLine]!
  subscriptionHistories: [CustomerSubscriptionContractSubscriptionHistory]!
  billingAttempts: [CustomerSubscriptionContractBillingAttempt]!
}

Fields

ResultCustomerSubscriptionContract.isSyncingSubscription ● Boolean! non-null scalar

定期購買契約データ同期中判別フラグ

• 説明： Shopifyと同期中かどうかを判別するフラグ
• データ例： TRUE
• 備考： TRUE：Shopifyと同期中, FALSE：Shopifyと同期済み

ResultCustomerSubscriptionContract.isManualPaymentMethod ● Boolean! non-null scalar

手動決済契約判別フラグ

• 説明： 契約の決済方法が手動決済かどうかを判別するフラグ
• データ例： TRUE
• 備考： TRUE：手動決済の契約, FALSE：通常決済の契約

ResultCustomerSubscriptionContract.createdAt ● String! non-null scalar

契約作成日（UTC）

• データ例： "2024-12-10T03:15:51.918Z"
• 備考： UTC

ResultCustomerSubscriptionContract.contractType ● ContractType! non-null enum

契約種別

• 説明： 定期プランの種別
• データ例： "STANDARD"

ResultCustomerSubscriptionContract.status ● SubscriptionStatus! non-null enum

契約情報のステータス

• 説明： 契約の現在の状態
• データ例： "ACTIVE"
• 備考： "ACTIVE"：アクティブ, "PAUSED"：一時停止, "CANCELLED"：解約

ResultCustomerSubscriptionContract.nextBillingDate ● String! non-null scalar

次回決済日時

• データ例： "2025-01-15T03:00:00.000Z"
• 備考： UTC

ResultCustomerSubscriptionContract.deliveryDays ● Int! non-null scalar

契約LT

• 説明： 設定画面 > お届け日の変更 > 注文されてから届くまでの最短日数（注文日を除く）で登録した契約LT
• データ例： 3

ResultCustomerSubscriptionContract.deliveryTime ● String scalar

お届け時間 - 識別タグ

• 説明： 設定画面 > お届け日の変更 > お届け時間設定に登録した「タグ」
• データ例： "AM"
• 備考： null : お届け時間指定なし

ResultCustomerSubscriptionContract.billingPolicyInterval ● BillingPolicyInterval! non-null enum

契約情報の決済周期（単位）

• 説明： 決済周期の単位
• データ例： "DAY"

ResultCustomerSubscriptionContract.billingPolicyIntervalCount ● Int! non-null scalar

契約情報の決済周期（数値）

• 説明： 決済周期
• データ例： 1

ResultCustomerSubscriptionContract.billingPolicyMinCycles ● Int scalar

契約情報の最低購入回数（オプション）

• 説明： 契約で設定された最低購入回数
• データ例： 1
• 備考： null: 最低購入回数はなし

ResultCustomerSubscriptionContract.billingPolicyMaxCycles ● Int scalar

契約情報の最大購入回数（オプション）

• 説明： 契約で設定された最大購入回数
• データ例： 1
• 備考： null: 最大購入回数が無制限

ResultCustomerSubscriptionContract.deliveryCountry ● String scalar

契約情報の配送先住所（国）

• 説明： 配送先住所の国名
• データ例： "Japan"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryCountryCode ● String scalar

契約情報の配送先住所（国コード、例: JP）

• 説明： 配送先住所の国コード
• データ例： "JP"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryProvince ● String scalar

契約情報の配送先住所（都道府県）

• 説明： 配送先住所の都道府県名
• データ例： "Tōkyō"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryProvinceCode ● String scalar

契約情報の配送先住所（都道府県コード）

• 説明： 配送先住所の都道府県コード
• データ例： "JP-13"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryZip ● String scalar

契約情報の配送先住所（郵便番号）

• 説明： 配送先住所の郵便番号
• データ例： "190-1111"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryCity ● String scalar

契約情報の配送先住所（市区町村）

• 説明： 配送先住所の市区町村名
• データ例： "Nishitama"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryAddress1 ● String scalar

契約情報の配送先住所（住所）

• 説明： 配送先住所の番地（住所1）
• データ例： "Nihongi, Mizuho"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryAddress2 ● String scalar

契約情報の配送先住所（建物名、部屋番号）

• 説明： 配送先住所の建物名、部屋番号（住所2）
• データ例： "test 111"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryFirstName ● String scalar

契約情報の配送先住所（名）

• 説明： 配送先住所の名（FirstName）
• データ例： "太郎"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryLastName ● String scalar

契約情報の配送先住所（姓）

• 説明： 配送先住所の姓（LastName）
• データ例： "山田"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryName ● String scalar

契約情報の配送先住所（名＋姓）

• 説明： 配送先住所の氏名（名＋姓）
• データ例： "太郎 山田"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryPhone ● String scalar

契約情報の配送先住所（電話番号）

• 説明： 配送先住所の電話番号
• データ例： "090-1111-2222"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryCompany ● String scalar

契約情報の配送先住所（会社名）

• 説明： 配送先住所の会社名
• データ例： "株式会社テスト"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContract.deliveryPriceAmount ● Float scalar

契約情報の決済時配送料金

• 説明： 配送時の決済配送料金
• データ例： 1000
• 備考： 原則nullにはならない

ResultCustomerSubscriptionContract.deliveryPriceCurrencyCode ● String scalar

契約情報の決済時配送料金通貨

• 説明： 配送時の決済配送料金通貨
• データ例： "JPY"
• 備考： 原則nullにはならない

ResultCustomerSubscriptionContract.excludeFromAutoCalculateDeliveryPrice ● Boolean! non-null scalar

配送料自動計算対象外フラグ

• 説明： 配送料の自動計算対象外かどうかを判別するフラグ
• データ例： FALSE
• 備考： TRUE：除外する, FALSE：除外しない

ResultCustomerSubscriptionContract.customerDisplayName ● String! non-null scalar

顧客表示名

• 説明： 顧客の表示名
• データ例： "太郎 山田"
• 備考： Customer.displayName の値が入る

ResultCustomerSubscriptionContract.originOrderId ● String scalar

初回注文のShopify管理ID

• 説明： 初回注文のShopify管理ID
• データ例： "gid://shopify/Order/5886530420849"
• 備考： null: アプリの移行機能やGraphQLで契約作成を行った場合

ResultCustomerSubscriptionContract.originOrderName ● String scalar

初回注文のShopify注文名

• 説明： 初回注文のShopify注文名
• データ例： "#2405"
• 備考： null: アプリの移行機能やGraphQLで契約作成を行った場合

ResultCustomerSubscriptionContract.originOrderToken ● String scalar

初回注文のShopify管理トークン

• 説明： 初回注文のShopify管理トークン
• データ例： "7ff232b1ea1d9c633f82b4607eca969b"
• 備考： null: アプリの移行機能やGraphQLで契約作成を行った場合

ResultCustomerSubscriptionContract.note ● String scalar

注文メモ

• 説明： 注文に関するメモ
• データ例： "メモ"
• 備考： null: 設定画面 > マイページ設定 > 注文メモ表示が未チェック

ResultCustomerSubscriptionContract.bulkPayCount ● Int scalar

一括払い定期用のサイクル内注文回数

• 説明： 一括払い定期契約の場合のサイクル内での注文回数
• データ例： 2
• 備考： null: 一括払い定期契約の場合に値が入る

ResultCustomerSubscriptionContract.bulkPayMinCycleCount ● Int scalar

一括払い定期用の最小購入サイクル数

• 説明： 一括払い定期契約の場合の最小購入サイクル数
• データ例： 1
• 備考： null: 一括払い定期契約の場合に値が入る

ResultCustomerSubscriptionContract.nextDeliveryDate ● String! non-null scalar

次回お届け日

• 説明： 更新する次回お届け日
• データ例： "2024-01-01"
• 備考： null: お届け日指定なし

ResultCustomerSubscriptionContract.deliveryTimeText ● String! non-null scalar

お届け時間 - 表示名

• 説明： 設定画面 > お届け日の変更 > お届け時間設定に登録した「お届け時間」
• データ例： "10:00~12:00"
• 備考： null: お届け時間指定なし

ResultCustomerSubscriptionContract.totalOrderCount ● Int! non-null scalar

現在の累計注文回数

• 説明： 現在までの累計注文回数
• データ例： 12

ResultCustomerSubscriptionContract.bulkPayNextBillingDate ● String scalar

一括払い定期用の次回支払い発生日（UTC）

• 説明： 一括払い定期契約の次回支払い発生日
• データ例： "2025-01-17T08:00:00.000Z"
• 備考： 一括払い定期契約の場合に値が入る

ResultCustomerSubscriptionContract.bulkPayCancellableBeginDate ● String scalar

一括払い定期用の解約可能期間開始日（UTC）

• 説明： 一括払い定期契約の解約可能期間開始日
• データ例： "2024-12-10T03:15:51.918Z"
• 備考： 一括払い定期契約の場合に値が入る

ResultCustomerSubscriptionContract.bulkPayCancellableEndDate ● String scalar

一括払い定期用の解約可能期間終了日（UTC）

• 説明： 一括払い定期契約の解約可能期間終了日
• データ例： "2024-12-10T03:15:51.918Z"
• 備考： 一括払い定期契約の場合に値が入る

ResultCustomerSubscriptionContract.canSkipCancel ● Boolean! non-null scalar

スキップ取消可能判別フラグ

• 説明： スキップ取消が可能かどうかを判別するフラグ
• データ例： TRUE
• 備考： TRUE: スキップ取消可能, FALSE: スキップ取消不可

ResultCustomerSubscriptionContract.startSyncSubscriptionDate ● String scalar

定期購買契約データ同期中判別フラグを立てた日時（UTC）

• 説明： 定期購買契約データ同期中判別フラグが立てられた日時（UTC）
• データ例： "2024-12-10T03:15:51.918Z"
• 備考： null: 契約作成以降、Shopifyと同期処理を行っていない

ResultCustomerSubscriptionContract.rank ● CustomerSubscriptionContractRank object

契約情報のランク情報

• 説明： 顧客契約のランク情報

ResultCustomerSubscriptionContract.customerPaymentMethod ● CustomerSubscriptionContractPaymentMethod object

顧客決済情報

• 説明： 顧客の決済方法に関する情報

ResultCustomerSubscriptionContract.subscriptionDiscounts ● [CustomerSubscriptionContractSubscriptionDiscount]! non-null object

割引情報のリスト

• 説明： 顧客の契約に対する割引情報のリスト

ResultCustomerSubscriptionContract.subscriptionLines ● [CustomerSubscriptionContractSubscriptionLine]! non-null object

定期購買商品情報のリスト

• 説明： 定期購買商品に関する情報のリスト

ResultCustomerSubscriptionContract.subscriptionHistories ● [CustomerSubscriptionContractSubscriptionHistory]! non-null object

スキップ履歴のリスト

• 説明： 顧客によるスキップ履歴のリスト

ResultCustomerSubscriptionContract.billingAttempts ● [CustomerSubscriptionContractBillingAttempt]! non-null object

決済履歴のリスト

• 説明： 決済履歴

Example

{
  "isSyncingSubscription": true,
  "isManualPaymentMethod": false,
  "createdAt": "2024-12-10T03:15:51.918Z",
  "contractType": "STANDARD",
  "status": "ACTIVE",
  "nextBillingDate": "2021-05-21T14:00:00Z",
  "deliveryDays": 3,
  "deliveryTime": "AM",
  "billingPolicyInterval": "DAY",
  "billingPolicyIntervalCount": 1,
  "billingPolicyMinCycles": 1,
  "billingPolicyMaxCycles": 1,
  "deliveryCountry": "Japan",
  "deliveryCountryCode": "JP",
  "deliveryProvince": "Tōkyō",
  "deliveryProvinceCode": "JP-13",
  "deliveryZip": "190-1111",
  "deliveryCity": "Nishitama",
  "deliveryAddress1": "Nihongi, Mizuho",
  "deliveryAddress2": "test 111",
  "deliveryFirstName": "太郎",
  "deliveryLastName": "山田",
  "deliveryName": "太郎 山田",
  "deliveryPhone": "090-1111-2222",
  "deliveryCompany": "株式会社テスト",
  "deliveryPriceAmount": 1000,
  "deliveryPriceCurrencyCode": "JPY",
  "excludeFromAutoCalculateDeliveryPrice": false,
  "customerDisplayName": "太郎 山田",
  "originOrderId": "gid://shopify/Order/5886530420849",
  "originOrderName": "#2405",
  "originOrderToken": "7ff232b1ea1d9c633f82b4607eca969b",
  "originOrderCreatedAt": "2024-12-10T03:15:51.918Z",
  "originOrderUpdatedAt": "2024-12-10T03:15:51.918Z",
  "originOrderTotalPriceAmount": 1000,
  "originOrderTotalPriceCurrencyCode": "JPY",
  "subscriptionLines": [
    {
      "lineId": "gid://shopify/SubscriptionLine/123456789",
      "productId": "gid://shopify/Product/7253940928625",
      "variantId": "gid://shopify/ProductVariant/41378934063217",
      "title": "アイスクリーム定期便",
      "variantTitle": "オレンジ",
      "sku": "icecream001",
      "variantImage": "https://cdn.shopify.com/variant-image.jpg",
      "quantity": 2,
      "currentPriceAmount": 330,
      "currentPriceCurrencyCode": "JPY",
      "lineDiscountedPriceAmount": 660,
      "lineDiscountedPriceCurrencyCode": "JPY",
      "onlineStorePreviewUrl": "https://test-store.myshopify.com/products/ice-cream-subscription"
    }
  ]
}

Returned By

customerSubscriptionContract query