📃Subscription Plans

Retrieve All Selling Plan Groups

get

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

Query parameters

namestringOptional

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

categorystringOptional

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

merchantCodestringOptional

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

descriptionstringOptional

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

idstringOptional

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

optionsstringOptional

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

sortBystringOptional

Field name to sort the results by.

sortOrderstring · enumOptional

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

Possible values:

Responses

200

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

application/json

400

Bad request, such as when there's an error in the query parameters.

application/json

get

HTTPcURLJavaScriptPython

GET /selling-plan-groups HTTP/1.1
Host: localhost:3002
Accept: */*

[
  {
    "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,
        "options": [
          "text"
        ],
        "billingAnchorActive": true,
        "billingIntervalType": "text",
        "billingIntervalValue": 1,
        "billingAnchors": [
          {
            "cutoffDay": 1,
            "day": 1,
            "month": 1,
            "type": "text"
          }
        ],
        "maxCycles": 1,
        "minCycles": 1,
        "deliveryAnchorActive": true,
        "deliveryIntervalType": "text",
        "deliveryIntervalValue": 1,
        "deliveryAnchors": [
          {
            "cutoffDay": 1,
            "day": 1,
            "month": 1,
            "type": "text"
          }
        ],
        "intent": "text",
        "preAnchorBehavior": "text",
        "inventoryPolicy": "text",
        "fixedAdjustmentActive": true,
        "fixedAdjustmentType": "text",
        "fixedAdjustmentValue": 1,
        "fixedAdjustmentValueType": "text",
        "recurringAdjustmentActive": true,
        "recurringAdjustmentType": "text",
        "recurringAdjustmentValue": 1,
        "recurringAdjustmentValueType": "text",
        "recurringAfterCycleNumber": 1,
        "metadata": {
          "selected": true,
          "needsToSave": true
        }
      }
    ]
  }
]

Get Specific Selling Plan Group

get

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

Path parameters

sellingPlanGroupIdstringRequired

The unique identifier of the selling plan group.

Responses

200

Successfully retrieved the selling plan group.

application/json

400

Bad request, such as when the selling plan group ID is invalid or not found.

application/json

500

Server error, such as when an unexpected error occurs during the retrieval process.

get

HTTPcURLJavaScriptPython

GET /selling-plan-groups/{sellingPlanGroupId} HTTP/1.1
Host: localhost:3002
Accept: */*

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

Get Products from Selling Plan Group

get

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

Path parameters

sellingPlanGroupIdstringRequired

The unique identifier of the selling plan group.

Responses

200

Successfully retrieved the products from the selling plan group.

application/json

400

Bad request, such as when the selling plan group ID is invalid or not found.

application/json

500

Server error, such as when an unexpected error occurs during the retrieval process.

get

HTTPcURLJavaScriptPython

GET /selling-plan-groups/{sellingPlanGroupId}/products HTTP/1.1
Host: localhost:3002
Accept: */*

{
  "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,
      "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"
        }
      ],
      "vendor": "text",
      "status": "text",
      "tracksInventory": true,
      "title": "text",
      "tags": [
        "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"
    }
  ]
}