Skip to main content

CustomerPlan

顧客向けプラン情報

type CustomerPlan {
  planId: String!
  name: String!
  description: String
  billingPolicyInterval: BillingPolicyInterval!
  billingPolicyIntervalCount: Int!
  billingPolicyMinCycles: Int
  billingPolicyMaxCycles: Int
  pricingPolicyAdjustmentType: PricingPolicyAdjustmentType
  pricingPolicyAdjustmentValue: Float
  firstPricingPolicyAdjustmentType: PricingPolicyAdjustmentType
  firstPricingPolicyAdjustmentValue: Float
  discountTimes: [CustomerDiscountTime!]
}

Fields​

CustomerPlan.planId ● String! non-null scalar​

プランID

  • 説明： SellingPlan の globally-unique ID.
  • データ例： gid://shopify/SellingPlan/1234567890

CustomerPlan.name ● String! non-null scalar​

プラン名

  • 説明： プラン名を設定した文字列
  • データ例： A商品プラン

CustomerPlan.description ● String scalar​

プラン説明

  • 説明： プランの説明を設定した文字列
  • データ例： A商品プランの説明です

CustomerPlan.billingPolicyInterval ● BillingPolicyInterval! non-null enum​

プランの決済周期（単位）

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

CustomerPlan.billingPolicyIntervalCount ● Int! non-null scalar​

プランの決済周期（数値）

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

CustomerPlan.billingPolicyMinCycles ● Int scalar​

プランの最低購入回数

  • 説明： プランの最低購入回数。2~100回の範囲で設定可能, null: なし

CustomerPlan.billingPolicyMaxCycles ● Int scalar​

プランの最高購入回数

  • 説明： プランの最高購入回数。2~100回の範囲で設定可能, null: 無制限

CustomerPlan.pricingPolicyAdjustmentType ● PricingPolicyAdjustmentType enum​

プランの継続割引の種別

  • 説明： 継続割引の種別
  • データ例： FIXED_AMOUNT

CustomerPlan.pricingPolicyAdjustmentValue ● Float scalar​

プランの継続割引の金額または割引率

  • 説明： 継続割引の金額または割引率
  • データ例： 1000

CustomerPlan.firstPricingPolicyAdjustmentType ● PricingPolicyAdjustmentType enum​

プランの初回割引の種別

  • 説明： 初回割引の種別
  • データ例： FIXED_AMOUNT

CustomerPlan.firstPricingPolicyAdjustmentValue ● Float scalar​

プランの初回割引の金額または割引率

  • 説明： 初回割引の金額または割引率
  • データ例： 1000

CustomerPlan.discountTimes ● [CustomerDiscountTime!] list object​

プランの回数割引の金額または割引率

  • 説明： 回数割引の金額または割引率

Example​

{
  "planId": "gid://shopify/SellingPlan/1234567890",
  "name": "プラン名",
  "description": "プラン説明",
  "billingPolicyInterval": "MONTH",
  "billingPolicyIntervalCount": 1,
  "pricingPolicyAdjustmentType": "FIXED_AMOUNT",
  "pricingPolicyAdjustmentValue": 1000
}

Member Of​

ResultCustomerPlanGroup object