📃Subscription Plans

Retrieve All Selling Plan Groups

Fetches all selling plan groups from the database, with optional filtering based on name, category, merchant code, description, ID, and options.

get

/selling-plan-groups

Query parameters

namestring

Fuzzy search filter for the name of the selling plan group.

categorystring

Exact match filter for the category of the selling plan group.

merchantCodestring

Fuzzy search filter for the merchant code associated with the selling plan group.

descriptionstring

Fuzzy search filter for the description of the selling plan group.

idstring

Exact match filter for the ID of the selling plan group.

optionsstring

Fuzzy search filter for the options associated with the selling plan group.

sortBystring

Field name to sort the results by.

sortOrderstring · enum

Order of sorting, ascending or descending. Default is ascending.

Options: asc, desc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://localhost:3002/selling-plan-groups'

200

400

200

[
  {
    "shop": "text",
    "id": "text",
    "name": "text",
    "description": "text",
    "merchantCode": "text",
    "productCount": 1,
    "options": [
      "text"
    ],
    "sellingPlans": [
      {
        "shop": "text",
        "id": "text",
        "name": "text",
        "description": "text",
        "category": "text",
        "position": 1,
        "billingAnchorActive": true,
        "billingIntervalType": "text",
        "billingIntervalValue": 1,
        "maxCycles": 1,
        "minCycles": 1,
        "deliveryAnchorActive": true,
        "deliveryIntervalType": "text",
        "deliveryIntervalValue": 1,
        "intent": "text",
        "preAnchorBehavior": "text",
        "inventoryPolicy": "text",
        "fixedAdjustmentActive": true,
        "fixedAdjustmentType": "text",
        "fixedAdjustmentValue": 1,
        "fixedAdjustmentValueType": "text",
        "recurringAdjustmentActive": true,
        "recurringAdjustmentType": "text",
        "recurringAdjustmentValue": 1,
        "recurringAdjustmentValueType": "text",
        "recurringAfterCycleNumber": 1,
        "options": [
          "text"
        ],
        "metadata": {
          "selected": true,
          "needsToSave": true
        },
        "billingAnchors": [
          {
            "cutoffDay": 1,
            "day": 1,
            "month": 1,
            "type": "text"
          }
        ],
        "deliveryAnchors": [
          {
            "cutoffDay": 1,
            "day": 1,
            "month": 1,
            "type": "text"
          }
        ]
      }
    ]
  }
]

A list of selling plan groups matching the filters, if any.

Get Specific Selling Plan Group

Retrieves detailed information about a specific selling plan group, including its associated selling plans.

get

/selling-plan-groups/{sellingPlanGroupId}

Path parameters

sellingPlanGroupIdstringrequired

The unique identifier of the selling plan group.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://localhost:3002/selling-plan-groups/{sellingPlanGroupId}'

200

400

500

200

{
  "id": "text",
  "shop": "text",
  "name": "text",
  "description": "text",
  "merchantCode": "text",
  "productCount": 1,
  "options": [
    "text"
  ],
  "sellingPlans": [
    {
      "shop": "text",
      "id": "text",
      "name": "text",
      "description": "text",
      "category": "text",
      "position": 1,
      "billingAnchorActive": true,
      "billingIntervalType": "text",
      "billingIntervalValue": 1,
      "maxCycles": 1,
      "minCycles": 1,
      "deliveryAnchorActive": true,
      "deliveryIntervalType": "text",
      "deliveryIntervalValue": 1,
      "intent": "text",
      "preAnchorBehavior": "text",
      "inventoryPolicy": "text",
      "fixedAdjustmentActive": true,
      "fixedAdjustmentType": "text",
      "fixedAdjustmentValue": 1,
      "fixedAdjustmentValueType": "text",
      "recurringAdjustmentActive": true,
      "recurringAdjustmentType": "text",
      "recurringAdjustmentValue": 1,
      "recurringAdjustmentValueType": "text",
      "recurringAfterCycleNumber": 1,
      "options": [
        "text"
      ],
      "metadata": {
        "selected": true,
        "needsToSave": true
      },
      "billingAnchors": [
        {
          "cutoffDay": 1,
          "day": 1,
          "month": 1,
          "type": "text"
        }
      ],
      "deliveryAnchors": [
        {
          "cutoffDay": 1,
          "day": 1,
          "month": 1,
          "type": "text"
        }
      ]
    }
  ]
}

Successfully retrieved the selling plan group.

Get Products from Selling Plan Group

Retrieves products and their variants associated with a given selling plan group ID.

get

/selling-plan-groups/{sellingPlanGroupId}/products

Path parameters

sellingPlanGroupIdstringrequired

The unique identifier of the selling plan group.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://localhost:3002/selling-plan-groups/{sellingPlanGroupId}/products'

200

400

500

200

{
  "success": true,
  "data": [
    {
      "productId": "text",
      "shop": "text",
      "commerceType": "text",
      "productCategoryName": "text",
      "productCategoryId": "text",
      "productCategoryisLeaf": true,
      "productCategoryisRoot": true,
      "excludeFromAddOns": true,
      "minVariantPriceAmount": 1,
      "minVariantPriceCurrency": "text",
      "maxVariantPriceAmount": 1,
      "maxVariantPriceCurrency": "text",
      "totalVariants": 1,
      "vendor": "text",
      "status": "text",
      "tracksInventory": true,
      "title": "text",
      "createdAt": "text",
      "descriptionHtml": "text",
      "publishedAt": "text",
      "sellingPlanGroupCount": 1,
      "customProductType": "text",
      "standardizedProductType": "text",
      "onlineStoreUrl": "text",
      "onlineStorePreviewUrl": "text",
      "legacyResourceId": "text",
      "productType": "text",
      "handle": "text",
      "featuredImageUrl": "text",
      "variants": [
        {
          "variantId": "text",
          "createdAt": "text",
          "barCode": "text",
          "sellableOnlineQuantity": 1,
          "taxable": true,
          "title": "text",
          "position": 1,
          "displayName": "text",
          "price": 1,
          "imageUrl": "text",
          "inventoryQuantity": 1,
          "availableForSale": true,
          "weight": 1,
          "weightUnit": "text",
          "inventoryPolicy": "text",
          "sku": "text"
        }
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

Successfully retrieved the products from the selling plan group.