---
title: "Get Selling Plan Groups"
method: GET
path: "/vendor/selling-plan-group"
tags: ["Purchase State"]
---

# Get Selling Plan Groups

`GET /vendor/selling-plan-group`

## Query parameters

- `cache` 'true' | 'false'

## Response `200`

Successful response

- ISmartrrSellingPlanGroup[]
  - `shopifyNumericId` number, required
  - `shopifyId` string, required
  - `name` string, required
  - `appId` string, nullable, required
  - `description` string, nullable, required
  - `merchantCode` string, required
  - `options` string[], required
  - `productIds` number[], required
  - `variantIds` number[], required
  - `subscriptionCount` number, required
  - `summary` string, nullable, required
  - `position` number, nullable, required
  - `sellingPlanCount` number, required
  - `enabledProductIdToVariantIdMap` IEnabledShopifyProductIdToShopifyVariantIdMap, required — ``` [productShopifyId: number]: number[]; ```
  - `sellingPlans` ISmartrrSellingPlan[], required
    - `shopifyNumericId` number, required
    - `shopifyId` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `options` string[], required
    - `billingPolicy` ISmartrrBillingPolicy, required
      - `interval` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required
      - `intervalCount` number, required
      - `maxCycles` number, nullable
      - `minCycles` number, nullable
    - `deliveryPolicy` ISmartrrDeliveryPolicy, required
      - `interval` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required
      - `intervalCount` number, required
    - `recurringDeliveries` boolean, required
    - `pricingPolicies` SmartrrSellingPlanPricingPolicy[], required
      - union
        - union
          - object
            - `adjustmentType` 'PERCENTAGE', required
            - `adjustmentValue` object, required
              - …
            - `pricingPolicyType` 'SellingPlanFixedPricingPolicy', required
          - object
            - `adjustmentType` 'FIXED_AMOUNT', required
            - `adjustmentValue` object, required
              - …
            - `pricingPolicyType` 'SellingPlanFixedPricingPolicy', required
          - object
            - `adjustmentType` 'PRICE', required
            - `adjustmentValue` object, required
              - …
            - `pricingPolicyType` 'SellingPlanFixedPricingPolicy', required
        - union
          - object
            - `adjustmentType` 'PERCENTAGE', required
            - `adjustmentValue` object, required
              - …
            - `pricingPolicyType` 'SellingPlanRecurringPricingPolicy', required
            - `afterCycle` number, required
          - object
            - `adjustmentType` 'FIXED_AMOUNT', required
            - `adjustmentValue` object, required
              - …
            - `pricingPolicyType` 'SellingPlanRecurringPricingPolicy', required
            - `afterCycle` number, required
          - object
            - `adjustmentType` 'PRICE', required
            - `adjustmentValue` object, required
              - …
            - `pricingPolicyType` 'SellingPlanRecurringPricingPolicy', required
            - `afterCycle` number, required

---

[API](https://skmtc.net/smartrr/apis/smartrr-api.md) · [All operations](https://skmtc.net/smartrr/apis/smartrr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartrr/smartrr-api/revisions/da24e062ff11/schema)