SubscriptionContract

契約

type SubscriptionContract {
  id: String!
  status: SubscriptionStatus!
  createdAt: DateTime!
  updatedAt: DateTime!
  cancelledAt: DateTime
  cancelReason: String
  cancelExtraText: String
  pausedAt: DateTime
  pauseReason: String
  pauseExtraText: String
  resumedAt: DateTime
  resumedAtFromPaused: DateTime
  nextBillingDate: DateTime!
  deliveryDays: Int!
  nextDeliveryDate: Date
  nextDeliveryTime: String
  deliveryDate: DateTime! @deprecated
  billingPolicyInterval: BillingPolicyInterval!
  billingPolicyIntervalCount: Int!
  billingPolicyMinCycles: Int
  billingPolicyMaxCycles: Int
  deliveryPolicyInterval: String!
  deliveryPolicyIntervalCount: 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
  currencyCode: String!
  deliveryPriceAmount: Float
  lines: [SubscriptionLine]
  skipHistories: [SubscriptionSkipHistory]
  originOrder: Order
  originOrderId: String
  originOrderName: String
  originOrderTest: Boolean
  billingAttempts: [BillingAttempt]
  subscriptionBillingAttemptCounts: Int!
  customer: Customer
  customerDisplayName: String!
}

Fields

SubscriptionContract.id ● String! non-null scalar

契約の globally-unique ID

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

SubscriptionContract.status ● SubscriptionStatus! non-null enum

ステータス

• 説明： 変更したい定期契約ステータス
• 例： "ACTIVE"

SubscriptionContract.createdAt ● DateTime! non-null scalar

契約作成日時（JST）

• 説明： 契約が作成された日時
• 例： "2024-12-10T03:15:51.918+09:00"
• 備考： JST形式で表記

SubscriptionContract.updatedAt ● DateTime! non-null scalar

契約更新日時（JST）

• 説明： 契約が最後に更新された日時
• 例： "2024-12-10T03:15:51.918+09:00"
• 備考： JST形式で表記

SubscriptionContract.cancelledAt ● DateTime scalar

解約日時

• 説明： 定期購買契約が解約された日時
• 例： "2024-12-10T03:15:51.918+09:00"
• 備考： JST形式で表記

SubscriptionContract.cancelReason ● String scalar

解約理由

• 説明： 定期購買契約の解約理由
• 例： "高い"

SubscriptionContract.cancelExtraText ● String scalar

解約アンケートの「その他」自由入力

• 説明： 解約アンケートの「その他」欄に自由に入力された内容
• 例： "●●の理由で契約解除します。"

SubscriptionContract.pausedAt ● DateTime scalar

一時停止日時

• 説明： 定期購買契約が一時停止された日時
• 例： "2024-12-10T03:15:51.918+09:00"
• 備考： JST形式で表記

SubscriptionContract.pauseReason ● String scalar

一時停止理由

• 説明： 定期購買契約が一時停止された理由
• 例： "休止"

SubscriptionContract.pauseExtraText ● String scalar

一時停止アンケートの「その他」自由入力

• 説明： 一時停止アンケートの「その他」欄に自由に入力された内容
• 例： "●●の理由で一時停止します。"

SubscriptionContract.resumedAt ● DateTime scalar

解約からの再開日時

• 説明： 解約後の再開日時
• 例： "2025-01-10T03:15:51.918+09:00"
• 備考： JST形式で表記

SubscriptionContract.resumedAtFromPaused ● DateTime scalar

一時停止からの再開日時

• 説明： 一時停止後の再開日時
• 例： "2025-01-10T03:15:51.918+09:00"
• 備考： JST形式で表記

SubscriptionContract.nextBillingDate ● DateTime! non-null scalar

次回決済日（JST）

• 説明： 次回決済日
• 例： "2025-01-21T14:00:00+09:00"
• 備考： JST形式で表記

SubscriptionContract.deliveryDays ● Int! non-null scalar

更新後の契約LT

• 説明： 設定画面 > お届け日の変更 > 注文されてから届くまでの最短日数（注文日を除く）
• 例： 3

SubscriptionContract.nextDeliveryDate ● Date scalar

次回お届け日

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

SubscriptionContract.nextDeliveryTime ● String scalar

次回お届け時間帯

• 説明： 更新する次回お届け時間帯
• 例： "午前中"

SubscriptionContract.billingPolicyInterval ● BillingPolicyInterval! non-null enum

決済周期（単位）

• 説明： 契約の決済周期の単位
• 例： "DAY"

SubscriptionContract.billingPolicyIntervalCount ● Int! non-null scalar

決済周期（数値）

• 説明： 契約の決済周期
• 例： 1

SubscriptionContract.billingPolicyMinCycles ● Int scalar

最低購入回数

• 説明： 契約の最低購入回数
• 例： 1

SubscriptionContract.billingPolicyMaxCycles ● Int scalar

最高購入回数

• 説明： 契約の最高購入回数
• 例： 1

SubscriptionContract.deliveryPolicyInterval ● String! non-null scalar

配送周期（単位）

• 説明： 配送の周期単位
• 例： "DAY"

SubscriptionContract.deliveryPolicyIntervalCount ● Int! non-null scalar

配送周期（数値）

• 説明： 配送の周期
• 例： 1

SubscriptionContract.deliveryCountry ● String scalar

配送先住所（国）

• 説明： 配送先の国名
• 例： "Japan"

SubscriptionContract.deliveryCountryCode ● String scalar

配送先住所（国コード）

• 説明： 配送先の国コード
• 例： "JP"

SubscriptionContract.deliveryProvince ● String scalar

配送先住所（都道府県）

• 説明： 配送先の都道府県名
• 例： "Tōkyō"

SubscriptionContract.deliveryProvinceCode ● String scalar

配送先住所（都道府県コード）

• 説明： 配送先の都道府県コード
• 例： "JP-13"

SubscriptionContract.deliveryZip ● String scalar

配送先住所（郵便番号）

• 説明： 配送先の郵便番号
• 例： "190-1111"

SubscriptionContract.deliveryCity ● String scalar

配送先住所（市区町村）

• 説明： 配送先の市区町村名
• 例： "Nishitama"

SubscriptionContract.deliveryAddress1 ● String scalar

配送先住所（住所１）

• 説明： 配送先の住所1
• 例： "Nihongi, Mizuho"

SubscriptionContract.deliveryAddress2 ● String scalar

配送先住所（住所２）

• 説明： 配送先の住所2（建物名、部屋番号）
• 例： "test 111"

SubscriptionContract.deliveryFirstName ● String scalar

配送先住所（名）

• 説明： 配送先の名
• 例： "太郎"

SubscriptionContract.deliveryLastName ● String scalar

配送先住所（姓）

• 説明： 配送先の姓
• 例： "山田"

SubscriptionContract.deliveryName ● String scalar

配送先住所（氏名）

• 説明： 配送先の氏名（名＋姓）
• 例： "太郎 山田"

SubscriptionContract.deliveryPhone ● String scalar

配送先住所（電話番号）

• 説明： 配送先の電話番号
• 例： "090-1111-2222"

SubscriptionContract.deliveryCompany ● String scalar

配送先住所（会社名）

• 説明： 配送先の会社名
• 例： "株式会社テスト"

SubscriptionContract.currencyCode ● String! non-null scalar

通貨

• 説明： 契約で使用する通貨
• 例： "JPY"

SubscriptionContract.deliveryPriceAmount ● Float scalar

送料

• 説明： 契約で使用する送料
• 例： 1000

SubscriptionContract.lines ● [SubscriptionLine] list object

契約商品一覧

• 説明： 契約の商品情報のリスト

SubscriptionContract.skipHistories ● [SubscriptionSkipHistory] list object

契約のスキップ履歴一覧

• 説明： 契約に関連するスキップ履歴のリスト

SubscriptionContract.originOrder ● Order object

契約作成時の初回注文情報

• 説明： 契約作成時に関連する初回注文情報

SubscriptionContract.originOrderId ● String scalar

初回注文のShopify管理ID

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

SubscriptionContract.originOrderName ● String scalar

初回注文のShopify注文名

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

SubscriptionContract.originOrderTest ● Boolean scalar

初回注文のテスト注文判定

• 説明： 契約作成時の初回注文がテスト注文かどうか
• 例： TRUE
• 備考： TRUE：テスト注文, FALSE：本番注文

SubscriptionContract.billingAttempts ● [BillingAttempt] list object

2回目以降決済情報一覧

• 説明： 契約に紐づく2回目以降の決済履歴の一覧

SubscriptionContract.subscriptionBillingAttemptCounts ● Int! non-null scalar

2回目以降決済情報の件数

• 説明： 契約に紐づく2回目以降の決済情報の件数
• 例： 5

SubscriptionContract.customer ● Customer object

契約の顧客情報

• 説明： 契約に紐づく顧客情報

SubscriptionContract.customerDisplayName ● String! non-null scalar

顧客表示名

• 説明： 顧客の表示名

• 例： "太郎 山田"

• 備考： Customer.displayName の値が入る

Show deprecated

Example

{
  "id": "gid://shopify/SubscriptionContract/1234567890",
  "status": "ACTIVE",
  "createdAt": "2024-12-10T03:15:51.918+09:00",
  "updatedAt": "2024-12-10T03:15:51.918+09:00",
  "cancelledAt": null,
  "cancelReason": "高い",
  "cancelExtraText": "●●の理由で契約解除します。",
  "pausedAt": null,
  "pauseReason": "休止",
  "pauseExtraText": "●●の理由で一時停止します。",
  "resumedAt": "2025-01-10T03:15:51.918+09:00",
  "resumedAtFromPaused": "2025-01-10T03:15:51.918+09:00",
  "nextBillingDate": "2025-01-21T14:00:00+09:00",
  "deliveryDays": 3,
  "nextDeliveryDate": "2024-01-01",
  "nextDeliveryTime": "午前中",
  "deliveryDate": "2024-01-01T10:00:00+09:00",
  "billingPolicyInterval": "DAY",
  "billingPolicyIntervalCount": 1,
  "billingPolicyMinCycles": 1,
  "billingPolicyMaxCycles": 1,
  "deliveryPolicyInterval": "DAY",
  "deliveryPolicyIntervalCount": 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": "株式会社テスト",
  "currencyCode": "JPY",
  "deliveryPriceAmount": 1000,
  "lines": [],
  "skipHistories": [],
  "originOrder": null,
  "originOrderId": "gid://shopify/Order/5805693632625",
  "originOrderName": "#1173",
  "originOrderTest": true,
  "billingAttempts": [],
  "subscriptionBillingAttemptCounts": 5,
  "customer": null,
  "customerDisplayName": "太郎 山田"
}

Returned By

subscriptionContracts query

Member Of

BillingAttempt object