📃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.

GEThttp://localhost:3002/selling-plan-groups

Query parameters

Response

200400

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

Body

application/json

shopstring

idstring

namestring

descriptionstring

merchantCodestring

productCountinteger

optionsarray of string

sellingPlansarray of SellingPlan (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3002/selling-plan-groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

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

Get Specific Selling Plan Group

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

GEThttp://localhost:3002/selling-plan-groups/{sellingPlanGroupId}

Path parameters

sellingPlanGroupId*string

The unique identifier of the selling plan group.

Response

200400500

Successfully retrieved the selling plan group.

Body

application/json

idstring

shopstring

namestring

descriptionstring

merchantCodestring

optionsarray of string

productCountinteger

sellingPlansarray of SellingPlan (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3002/selling-plan-groups/{sellingPlanGroupId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

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

Get Products from Selling Plan Group

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

GEThttp://localhost:3002/selling-plan-groups/{sellingPlanGroupId}/products

Path parameters

sellingPlanGroupId*string

The unique identifier of the selling plan group.

Response

200400500

Successfully retrieved the products from the selling plan group.

Body

application/json

successboolean

dataarray of Product (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3002/selling-plan-groups/{sellingPlanGroupId}/products', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

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