v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

List selling plan groups

This API list available selling plan of a store.

Rate limit - 1/5s

get/2023-10/sellingPlanGroup

Response

200

successboolean

messagestring

codestring

{"stackTrail":"paths:/2023-10/sellingPlanGroup:get:responses:200:content:application/json:schema:properties:pageInfo","oasType":"schema","type":"unknown"}

Example response

{
  "success": true,
  "message": "Selling plans fetched successfully",
  "data": [
    {
      "id": 179,
      "name": "Subscribe and Save 3",
      "position": 1,
      "merchantCode": "save3",
      "options": [
        "Frequency"
      ],
      "summary": "2 delivery frequencies, $0 discount",
      "createdAt": "2023-08-21T10:40:57.000Z",
      "updatedAt": "2023-08-21T10:42:00.000Z",
      "sellingPlans": [
        {
          "id": 801,
          "shopifyId": 689915396405,
          "name": "Deliver every month",
          "options": [
            "Deliver every month"
          ],
          "billingPolicy": {
            "interval": "MONTH",
            "intervalCount": 1
          },
          "deliveryPolicy": {
            "interval": "MONTH",
            "intervalCount": 1
          }
        }
      ]
    }
  ],
  "code": "SUCCESS"
}