目次

１．基本情報

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

項目名 内容
アクション名 getSubscription
リクエストメソッド POST

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

項目名 内容 必須 入力例 備考
subscriptionId 定期購買ID はい gid://shopify/SubscriptionContract/123456789

３．レスポンス内容

指定された定期購買IDの詳細情報を返却されます。

■正常時レスポンス

プロパティ 型 説明
originOrderId string null
originOrderToken string null
originOrderName string null
customerDisplayName string null
customerPaymentMethodId number null
subscriptionContractId string 契約情報のShopify管理ID
billingPolicyInterval string 契約情報の決済周期（単位）
billingPolicyIntervalCount number 契約情報の決済周期
billingPolicyMinCycles number null
billingPolicyMaxCycles number null
status string 契約情報のステータス（ACTIVE、PAUSED、CANNCELLED）
deliveryPriceAmount number null
deliveryPriceCurrencyCode string 契約情報の決済時配送料金通貨
deliveryAddress1 string null
deliveryAddress2 string null
deliveryCity string null
deliveryCompany string null
deliveryCountry string null
deliveryCountryCode string null
deliveryFirstName string null
deliveryLastName string null
deliveryName string null
deliveryPhone string null
deliveryProvince string null
deliveryProvinceCode string null
deliveryZip string null
deliveryDays number 契約情報のお届けまでに必要な日数
deliveryTime string null
subscriptionDiscounts array() 割引情報
L subscriptionManualDiscountId string 割引情報のShopify管理ID
L title string 割引タイトル
L percentage number null
L amount number null
L rank boolean true：ランク機能による割引
L deliveryDiscount boolean true：一般設定＞決済設定＞指定金額を超えた場合の割引
L coupon boolean true：一般設定＞クーポン設定＞マイページでのクーポン適用機能による割引
contractType string null
totalOrderCount number null
bulkPayCount number null
bulkPayMinCycleCount number null
bulkPayNextBillingDate timestamp 一括払い定期用の次回支払い発生日
bulkPayCancellableBeginDate timestamp 一括払い定期用の解約可能期間開始日
bulkPayCancellableEndDate timestamp 一括払い定期用の解約可能期間終了日
subscriptionLines array()
L applicationId number 定期購買アプリ内での定期購買契約管理ID
L productId string null
L variantId string null
L variantImage string null
L title string タイトル

■異常時レスポンス

| --- | --- | --- |