プラングループ取得
1.基本情報
アプリのプラン設定から登録されたプラングループの情報を取得する。
項目名 | 内容 |
---|---|
アクション名 | getPlanGroups |
リクエストメソッド | POST |
2.リクエストに必要な内容
なし
3.レスポンス内容
アプリのプラン設定から登録されたプラングループの情報が返却されます。
■正常時レスポンス
プロパティ | 型 | 説明 |
---|---|---|
planGroup | array() | プラングループの一覧 |
L merchantCode | strin | プラングループタイトル |
L name | string | 公開タイトル |
L planGroupId | string | プラングループのShopify管理ID |
L plans | array() | プラン情報 |
L planId | string | プランのShopify管理ID |
L name | string | プラン名 |
L description | string | null | プランの説明 |
L billingPolicyInterval | string | 決済周期(DAY:日、WEEK:週、MONTH:月、YEAR:年) |
L billingPolicyIntervalCount | number | null | 決済周期(数値) |
L pricingPolicyAdjustmentType | string | FIXED_AMOUNT : 固定額、PERCENTAGE:パーセント割引 |
L pricingPolicyAdjustmentValue | number | null | 割引額/パーセント |
1.基本情報
アプリのプラン設定から登録されたプラングループの情報を取得する。
項目名 | 内容 |
---|---|
アクション名 | getPlanGroups |
リクエストメソッド | POST |
2.リクエストに必要な内容
なし
3.レスポンス内容
アプリのプラン設定から登録されたプラングループの情報が返却されます。
■正常時レスポンス
プロパティ | 型 | 説明 |
---|---|---|
planGroup | array() | プラングループの一覧 |
L merchantCode | strin | プラングループタイトル |
L name | string | 公開タイトル |
L planGroupId | string | プラングループのShopify管理ID |
L plans | array() | プラン情報 |
L planId | string | プランのShopify管理ID |
L name | string | プラン名 |
L description | string | null | プランの説明 |
L billingPolicyInterval | string | 決済周期(DAY:日、WEEK:週、MONTH:月、YEAR:年) |
L billingPolicyIntervalCount | number | null | 決済周期(数値) |
L pricingPolicyAdjustmentType | string | FIXED_AMOUNT : 固定額、PERCENTAGE:パーセント割引 |
L pricingPolicyAdjustmentValue | number | null | 割引額/パーセント |