ResultCustomerSubscriptionContracts

顧客向け契約一覧

type ResultCustomerSubscriptionContracts {
  subscriptionContractId: String!
  isSyncingSubscription: Boolean!
  createdAt: String!
  status: SubscriptionStatus!
  nextBillingDate: String!
  nextDeliveryDate: String!
  deliveryDays: Int!
  deliveryTime: String
  deliveryTimeText: 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
  originOrderToken: String
  originOrderName: String
  subscriptionLines: [CustomerSubscriptionContractsSubscriptionLine]!
  billingAttempts: [CustomerSubscriptionContractsBillingAttempt]!
  subscriptionDiscounts: [CustomerSubscriptionContractsSubscriptionDiscount]!
}

Fields

ResultCustomerSubscriptionContracts.subscriptionContractId ● String! non-null scalar

契約情報のShopify管理ID

• 説明： 処理対象契約の globally-unique ID.
• データ例： "gid://shopify/SubscriptionContract/18913493105"

ResultCustomerSubscriptionContracts.isSyncingSubscription ● Boolean! non-null scalar

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

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

ResultCustomerSubscriptionContracts.createdAt ● String! non-null scalar

契約作成日

• 説明： 契約の作成日
• データ例： "2025-01-16T03:00:00.000Z"
• 備考： UTC

ResultCustomerSubscriptionContracts.status ● SubscriptionStatus! non-null enum

契約情報のステータス

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

ResultCustomerSubscriptionContracts.nextBillingDate ● String! non-null scalar

次回決済日時

• 説明： 次回決済日
• データ例： "2025-01-16T03:00:00.000Z"
• 備考： UTC

ResultCustomerSubscriptionContracts.nextDeliveryDate ● String! non-null scalar

次回お届け日

• 説明： 次回お届け日
• データ例： "2025-01-19T03:00:00.000Z"
• 備考： UTC

ResultCustomerSubscriptionContracts.deliveryDays ● Int! non-null scalar

契約LT

• 説明： 設定画面 > お届け日の変更 > 注文されてから届くまでの最短日数（注文日を除く）
• データ例： 3
• 備考： 指定なしの場合は -1

ResultCustomerSubscriptionContracts.deliveryTime ● String scalar

お届け時間 - 識別タグ

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

ResultCustomerSubscriptionContracts.deliveryTimeText ● String scalar

お届け時間 - 表示名

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

ResultCustomerSubscriptionContracts.billingPolicyInterval ● BillingPolicyInterval! non-null enum

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

• 説明： 決済の周期単位
• データ例： "DAY"
• 備考： "DAY", "MONTH", "WEEK", "YEAR"

ResultCustomerSubscriptionContracts.billingPolicyIntervalCount ● Int! non-null scalar

契約情報の決済周期

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

ResultCustomerSubscriptionContracts.billingPolicyMinCycles ● Int scalar

契約情報の最低購入回数

• 説明： 最低購入回数の制限
• データ例： 1
• 備考： null: 最低購入回数なし

ResultCustomerSubscriptionContracts.billingPolicyMaxCycles ● Int scalar

契約情報の最大購入回数

• 説明： 最大購入回数の制限
• データ例： 1
• 備考： null: 最大購入回数が無制限

ResultCustomerSubscriptionContracts.deliveryCountry ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryCountryCode ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryProvince ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryProvinceCode ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryZip ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryCity ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryAddress1 ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryAddress2 ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryFirstName ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryLastName ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryName ● String scalar

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

• 説明： 配送先のフルネーム
• データ例： "太郎 山田"
• 備考： null: 配送不要な契約の場合

ResultCustomerSubscriptionContracts.deliveryPhone ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryCompany ● String scalar

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

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

ResultCustomerSubscriptionContracts.deliveryPriceAmount ● Float scalar

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

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

ResultCustomerSubscriptionContracts.deliveryPriceCurrencyCode ● String scalar

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

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

ResultCustomerSubscriptionContracts.excludeFromAutoCalculateDeliveryPrice ● Boolean scalar

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

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

ResultCustomerSubscriptionContracts.customerDisplayName ● String scalar

顧客表示名

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

ResultCustomerSubscriptionContracts.originOrderId ● String scalar

初回注文のShopify管理ID

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

ResultCustomerSubscriptionContracts.originOrderToken ● String scalar

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

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

ResultCustomerSubscriptionContracts.originOrderName ● String scalar

初回注文のShopify注文名

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

ResultCustomerSubscriptionContracts.subscriptionLines ● [CustomerSubscriptionContractsSubscriptionLine]! non-null object

定期購買商品情報

• 説明： 定期購買契約に紐づく商品の情報

ResultCustomerSubscriptionContracts.billingAttempts ● [CustomerSubscriptionContractsBillingAttempt]! non-null object

決済履歴

• 説明： 定期購買契約に関する決済の履歴

ResultCustomerSubscriptionContracts.subscriptionDiscounts ● [CustomerSubscriptionContractsSubscriptionDiscount]! non-null object

割引情報のリスト

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

Example

{
  "subscriptionContracts": [
    {
      "subscriptionContractId": "gid://shopify/SubscriptionContract/18913493105",
      "isSyncingSubscription": true,
      "createdAt": "2025-01-16T03:00:00.000Z",
      "contractType": "STANDARD",
      "status": "ACTIVE",
      "nextBillingDate": "2025-01-16T03:00:00.000Z",
      "nextDeliveryDate": "2025-01-19T03:00:00.000Z",
      "deliveryDays": 3,
      "deliveryTime": "AM",
      "deliveryTimeText": "10:00~12:00",
      "billingPolicyInterval": "DAY",
      "billingPolicyIntervalCount": 1,
      "billingPolicyMinCycles": 1,
      "billingPolicyMaxCycles": 1,
      "deliveryCountry": "Japan",
      "deliveryCountryCode": "JP",
      "deliveryProvince": "Tōkyō",
      "deliveryProvinceCode": "JP-13",
      "deliveryZip": "190-1111",
      "deliveryCity": "Nishitama",
      "deliveryLastName": "山田",
      "deliveryName": "太郎 山田",
      "deliveryPhone": "090-1111-2222",
      "deliveryCompany": "株式会社テスト",
      "deliveryPriceAmount": 1000,
      "deliveryPriceCurrencyCode": "JPY",
      "excludeFromAutoCalculateDeliveryPrice": false,
      "customerDisplayName": "太郎 山田",
      "originOrderId": "gid://shopify/Order/5886530420849",
      "originOrderName": "#2405",
      "bulkPayNextBillingDate": "2024-12-10T03:15:51.918Z",
      "bulkPayCancellableBeginDate": "2024-12-10T03:15:51.918Z",
      "bulkPayCancellableEndDate": "2024-12-10T03:15:51.918Z",
      "canSkipCancel": true,
      "startSyncSubscriptionDate": "2024-12-10T03:15:51.918Z",
      "rank": "GOLD",
      "customerPaymentMethod": {
        "id": "gid://shopify/CustomerPaymentMethod/123456789",
        "customerId": "gid://shopify/Customer/123456789",
        "paymentMethodType": "CREDIT_CARD",
        "paymentMethodDetails": {
          "cardBrand": "VISA",
          "cardLast4": "1234",
          "cardExpirationDate": "2025-01-01"
        }
      },
      "subscriptionDiscounts": [],
      "subscriptionLines": [],
      "subscriptionHistories": [],
      "billingAttempts": []
    }
  ]
}

Returned By

customerSubscriptionContracts query

Member Of

ResultCustomerSubscriptionContractsForPagination object