Bundle

Private Bundle API endpoints

Endpoints

GET/bundles
POST/bundles
GET/bundles/{bundle_id}
PUT/bundles/{bundle_id}
GET/bundles/{bundle_id}/items
POST/bundles/{bundle_id}/items
POST/bundles/{bundle_id}/items/batch
GET/bundles/{bundle_id}/items/{item_id}
PUT/bundles/{bundle_id}/items/{item_id}
DELETE/bundles/{bundle_id}/items/{item_id}
GET/bundles/{bundle_id}/groups
POST/bundles/{bundle_id}/publish
POST/bundles/{bundle_id}/unpublish
POST/bundles/{bundle_id}/archive
POST/bundles/{bundle_id}/metadata
POST/bundles/{bundle_id}/plans
GET/bundles/{bundle_id}/plans/{plan_id}
PUT/bundles/{bundle_id}/plans/{plan_id}
POST/bundles/{bundle_id}/plans/{plan_id}/archive

Get list of bundles

GET /bundles

An API endpoint to get list of bundles. The private API can access both published and unpublished bundles. Relation fields are only populated when requested through expand. Accepted values: images, rulesets, plans, preferences, filters, discounts, prices, items_count, tags, metadata. Unrequested relations come back as empty arrays (items_count as 0, metadata as null); tags and tags_meta are both driven by expand=tags. Unknown names are ignored.

Query parameters

pageoptionalinteger

Page number for pagination

per_pageoptionalinteger

Items per page

Defaults to 10.

ids[]optionalinteger[]

Filter by bundle IDs. Values must be unique.

slugs[]optionalstring[]

Filter by bundle slugs. Values must be unique.

tags[]optionalstring[]

Filter by tags. Values must be unique.

publishedoptionalboolean

Filter by published status

configurableoptionalboolean

Filter by configurable bundles

digitaloptionalboolean

Filter by digital bundles

expand[]optionalstring[]

List of relations to expand in the response.

sort[field]optionalstring

Field to sort by. Required whenever any sort[...] parameter is sent, so sort[direction] on its own is rejected.

Possible values: id, name.

sort[direction]optionalstring

Sort direction; defaults to asc.

Possible values: asc, desc.

Defaults to "asc".

Returnsobject

Bundles list response

paginationobject

dataBundle[]

curl https://api.subbly.co/private/v1/bundles \
  -H 'X-API-KEY: <api-key>'

Response

{
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "from": 1,
    "to": 1,
    "total": 20
  },
  "data": [
    {
      "id": 1,
      "name": "Bundle Name",
      "slug": "Bundle slug",
      "digital": false,
      "delivery_info": "delivery_info",
      "configurable": true,
      "images": [
        {
          "id": 1,
          "url": "https://cdn.filestackcontent.com/security=p:<policy>,s:<signature>/resize=w:1000,h:1000,fit:max/output=format:png/quality=v:70/AaBbCcDdEeFf",
          "order": 1,
          "created_at": "2022-04-01 00:00:00",
          "updated_at": "2022-04-01 00:00:00"
        }
      ],
      "description": "description",
      "hidden_items": true,
      "searchable": false,
      "show_ruleset_name": false,
      "quantity_selectors": [
        1
      ],
      "selection_type": "variant",
      "discount_type": "per_item",
      "price_type": "per_item",
      "ruleset_type": "total",
      "appearance_type": "one_step",
      "rulesets": [
        {
          "id": 1,
          "name": "Ruleset Name",
          "min_quantity": 1,
          "max_quantity": 2,
          "cta_text": "Add to cart",
          "products": [
            {}
          ],
          "created_at": "2022-04-01 00:00:00",
          "updated_at": "2022-04-01 00:00:00"
        }
      ],
      "plans": [
        {
          "id": 1,
          "pricing": {},
          "plan": {},
          "variant": {},
          "pricings": [
            {}
          ],
          "variants": [
            {}
          ],
          "prices": [
            {}
          ],
          "discounts": [
            {}
          ],
          "created_at": "2022-04-01 00:00:00",
          "updated_at": "2022-04-01 00:00:00"
        }
      ],
      "preferences": [
        {
          "id": 1,
          "title": "Do you want only vageterian dishes?",
          "attribute_id": 1,
          "metafield_id": 1,
          "values": [
            {}
          ],
          "created_at": "2022-04-01 00:00:00",
          "updated_at": "2022-04-01 00:00:00"
        }
      ],
      "filters": [
        {
          "id": 1,
          "title": "Type of dish",
          "attribute_id": 1,
          "metafield_id": 1,
          "values": [
            {}
          ],
          "created_at": "2022-04-01 00:00:00",
          "updated_at": "2022-04-01 00:00:00"
        }
      ],
      "discounts": [
        {
          "id": 1,
          "ruleset_id": 1,
          "plan_id": 1,
          "ranges": [
            {}
          ],
          "created_at": "2022-04-01 00:00:00",
          "updated_at": "2022-04-01 00:00:00"
        }
      ],
      "prices": [
        {
          "id": 1,
          "ruleset_id": 1,
          "plan_id": 1,
          "ranges": [
            {}
          ],
          "created_at": "2022-04-01 00:00:00",
          "updated_at": "2022-04-01 00:00:00"
        }
      ],
      "tags": [
        "new",
        "bundle"
      ],
      "tags_meta": [
        {
          "id": 1,
          "value": "new"
        },
        {
          "id": 2,
          "value": "bundle"
        }
      ],
      "setup_fee": 500,
      "gifting_enabled": false,
      "pause_enabled": false,
      "pre_order_end_at": "2024-12-31",
      "funnel_id": 1,
      "change_product_collection_id": 1,
      "collect_shipping_address": true,
      "published": true,
      "items_count": 5,
      "plans_count": 2,
      "rulesets_count": 1,
      "metadata": [
        {
          "id": 1,
          "name": "Color",
          "slug": "color-red",
          "description": "description",
          "unit": "kg",
          "data_type": "single_line_string",
          "preset": true,
          "multiple": true,
          "variant": true,
          "access_level": "storefront",
          "save_behavior": "customer",
          "editable": true,
          "values": [
            {}
          ]
        }
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ]
}

Create a new bundle

POST /bundles

This operation accepts no expand parameter, so the relation fields of the returned bundle are always empty. Read the bundle back with expand to see them.

Request body

configurableRequiredinteger

Possible values: 0, 1.

selection_typeoptionalstring | null

Required when configurable=1. When configurable=0 any value sent is ignored and stored as null.

Possible values: variant, product, single_product.

digitaloptionalinteger

Possible values: 0, 1.

slugRequiredstring

Must be unique among the shop's bundles.

nameoptionalstring | null

hidden_itemsoptionalinteger

Possible values: 0, 1.

searchableoptionalinteger

Possible values: 0, 1.

show_ruleset_nameoptionalinteger

Possible values: 0, 1.

descriptionoptionalstring | null

delivery_infooptionalstring | null

setup_feeoptionalinteger | null

pre_order_end_atoptionalstring | null

Date in Y-m-d format. Must be today or later; past dates are rejected.

Format: date.

gifting_enabledoptionalinteger

Prohibited when digital=1.

Possible values: 0, 1.

pause_enabledoptionalinteger

0 is only accepted on plans with the optional-pause feature; other shops must send 1.

Possible values: 0, 1.

price_typeoptionalstring | null

Only accepted for configurable bundles; rejected when selection_type is single_product, when ruleset_type is total, or when discount_type is also non-null.

Possible values: total, per_item.

discount_typeoptionalstring | null

Only accepted for configurable bundles; rejected when price_type is also non-null (except for single_product bundles).

Possible values: per_item, total, percentage.

ruleset_typeoptionalstring

Omit the field to leave it unset; sending an explicit null is rejected. Only accepted for configurable bundles whose selection_type is not single_product.

Possible values: quantity, total.

appearance_typeoptionalstring

Omit the field to leave it unset; sending an explicit null is rejected. Only accepted for configurable bundles whose selection_type is not single_product.

Possible values: one_step, two_step, without_ruleset.

quantity_selectorsoptionalinteger[] | null

Only accepted for configurable bundles whose selection_type is variant or product; prohibited otherwise. Must be a JSON list, not an object.

collect_shipping_addressoptionalinteger | null

Must be 1 unless the bundle is digital; 0 is only accepted when digital=1.

Possible values: 0, 1.

funnel_idoptionalinteger | null

tagsoptionalobject

createoptionalobject[]

filtersoptionalobject

Only accepted for configurable bundles whose selection_type is variant or product; prohibited otherwise.

createoptionalobject[]

preferencesoptionalobject

Only accepted for configurable bundles whose selection_type is variant or product; prohibited otherwise.

createoptionalobject[]

rulesetsoptionalobject

Only accepted for configurable bundles whose selection_type is variant or product; prohibited otherwise.

createoptionalobject[]

Each min must be less than or equal to max (max null means unbounded) and mins must be distinct. For ruleset_type=quantity the ranges must not overlap. For ruleset_type=total the ranges must be contiguous: the lowest must start at 0, each next min must equal the previous max plus 1, and the highest must have max null.

imagesoptionalobject

createoptionalobject[]

ReturnsBundle

Bundle created successfully

idinteger

namestring

slugstring

digitalboolean

delivery_infostring | null

configurableboolean

imagesProductImage[]

descriptionstring | null

hidden_itemsboolean

searchableboolean

show_ruleset_nameboolean

quantity_selectorsinteger[] | null

selection_typestring | null

Possible values: variant, product, single_product.

discount_typestring | null

Possible values: per_item, total, percentage.

price_typestring | null

Possible values: per_item, total.

ruleset_typestring | null

Possible values: total, quantity.

appearance_typestring | null

Possible values: one_step, two_step, without_ruleset, after_checkout.

rulesetsBundleRuleset[]

plansBundlePlan[]

preferencesBundlePreference[]

filtersBundleFilter[]

discountsBundleDiscount[]

pricesBundlePrice[]

tagsstring[]

tags_metaobject[]

setup_feeinteger | null

gifting_enabledboolean

pause_enabledboolean

pre_order_end_atstring | null

Format: date.

funnel_idinteger | null

change_product_collection_idinteger | null

ID of the product collection used for cross-product plan switching.

collect_shipping_addressboolean

publishedboolean

items_countinteger

plans_countinteger

rulesets_countinteger

metadataEntityMetadata[] | null

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl -X POST https://api.subbly.co/private/v1/bundles \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "configurable": 0,
  "selection_type": "variant",
  "digital": 0,
  "slug": "slug",
  "name": "name",
  "hidden_items": 0,
  "searchable": 0,
  "show_ruleset_name": 0,
  "description": "description",
  "delivery_info": "delivery_info",
  "setup_fee": 0,
  "pre_order_end_at": "2026-01-15",
  "gifting_enabled": 0,
  "pause_enabled": 0,
  "price_type": "total",
  "discount_type": "per_item",
  "ruleset_type": "quantity",
  "appearance_type": "one_step",
  "quantity_selectors": [
    1
  ],
  "collect_shipping_address": 0,
  "funnel_id": 1,
  "tags": {
    "create": [
      {
        "value": "value"
      }
    ]
  },
  "filters": {
    "create": [
      {
        "metadata_id": 1
      }
    ]
  },
  "preferences": {
    "create": [
      {
        "attribute_id": 1,
        "title": "title"
      }
    ]
  },
  "rulesets": {
    "create": [
      {
        "min": 0,
        "max": 1,
        "name": "name",
        "cta_text": "cta_text"
      }
    ]
  },
  "images": {
    "create": [
      {
        "url": "url",
        "order": 0
      }
    ]
  }
}'

Response

{
  "id": 1,
  "name": "Bundle Name",
  "slug": "Bundle slug",
  "digital": false,
  "delivery_info": "delivery_info",
  "configurable": true,
  "images": [
    {
      "id": 1,
      "url": "https://cdn.filestackcontent.com/security=p:<policy>,s:<signature>/resize=w:1000,h:1000,fit:max/output=format:png/quality=v:70/AaBbCcDdEeFf",
      "order": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "description": "description",
  "hidden_items": true,
  "searchable": false,
  "show_ruleset_name": false,
  "quantity_selectors": [
    1
  ],
  "selection_type": "variant",
  "discount_type": "per_item",
  "price_type": "per_item",
  "ruleset_type": "total",
  "appearance_type": "one_step",
  "rulesets": [
    {
      "id": 1,
      "name": "Ruleset Name",
      "min_quantity": 1,
      "max_quantity": 2,
      "cta_text": "Add to cart",
      "products": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "plans": [
    {
      "id": 1,
      "pricing": {},
      "plan": {},
      "variant": {},
      "pricings": [
        {}
      ],
      "variants": [
        {}
      ],
      "prices": [
        {}
      ],
      "discounts": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "preferences": [
    {
      "id": 1,
      "title": "Do you want only vageterian dishes?",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "filters": [
    {
      "id": 1,
      "title": "Type of dish",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "tags": [
    "new",
    "bundle"
  ],
  "tags_meta": [
    {
      "id": 1,
      "value": "new"
    },
    {
      "id": 2,
      "value": "bundle"
    }
  ],
  "setup_fee": 500,
  "gifting_enabled": false,
  "pause_enabled": false,
  "pre_order_end_at": "2024-12-31",
  "funnel_id": 1,
  "change_product_collection_id": 1,
  "collect_shipping_address": true,
  "published": true,
  "items_count": 5,
  "plans_count": 2,
  "rulesets_count": 1,
  "metadata": [
    {
      "id": 1,
      "name": "Color",
      "slug": "color-red",
      "description": "description",
      "unit": "kg",
      "data_type": "single_line_string",
      "preset": true,
      "multiple": true,
      "variant": true,
      "access_level": "storefront",
      "save_behavior": "customer",
      "editable": true,
      "values": [
        {}
      ]
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Get bundle by ID

GET /bundles/{bundle_id}

A detailed description of the bundle. The private API can access both published and unpublished bundles. Relation fields are only populated when requested through expand. Accepted values: images, rulesets, plans, preferences, filters, discounts, prices, items_count, tags, metadata. Unrequested relations come back as empty arrays (items_count as 0, metadata as null); tags and tags_meta are both driven by expand=tags. Unknown names are ignored.

Path parameters

bundle_idRequiredinteger

Bundle ID

Query parameters

expand[]optionalstring[]

List of relations to expand in the response.

ReturnsBundle

Bundle object response

idinteger

namestring

slugstring

digitalboolean

delivery_infostring | null

configurableboolean

imagesProductImage[]

descriptionstring | null

hidden_itemsboolean

searchableboolean

show_ruleset_nameboolean

quantity_selectorsinteger[] | null

selection_typestring | null

Possible values: variant, product, single_product.

discount_typestring | null

Possible values: per_item, total, percentage.

price_typestring | null

Possible values: per_item, total.

ruleset_typestring | null

Possible values: total, quantity.

appearance_typestring | null

Possible values: one_step, two_step, without_ruleset, after_checkout.

rulesetsBundleRuleset[]

plansBundlePlan[]

preferencesBundlePreference[]

filtersBundleFilter[]

discountsBundleDiscount[]

pricesBundlePrice[]

tagsstring[]

tags_metaobject[]

setup_feeinteger | null

gifting_enabledboolean

pause_enabledboolean

pre_order_end_atstring | null

Format: date.

funnel_idinteger | null

change_product_collection_idinteger | null

ID of the product collection used for cross-product plan switching.

collect_shipping_addressboolean

publishedboolean

items_countinteger

plans_countinteger

rulesets_countinteger

metadataEntityMetadata[] | null

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl https://api.subbly.co/private/v1/bundles/{bundle_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "name": "Bundle Name",
  "slug": "Bundle slug",
  "digital": false,
  "delivery_info": "delivery_info",
  "configurable": true,
  "images": [
    {
      "id": 1,
      "url": "https://cdn.filestackcontent.com/security=p:<policy>,s:<signature>/resize=w:1000,h:1000,fit:max/output=format:png/quality=v:70/AaBbCcDdEeFf",
      "order": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "description": "description",
  "hidden_items": true,
  "searchable": false,
  "show_ruleset_name": false,
  "quantity_selectors": [
    1
  ],
  "selection_type": "variant",
  "discount_type": "per_item",
  "price_type": "per_item",
  "ruleset_type": "total",
  "appearance_type": "one_step",
  "rulesets": [
    {
      "id": 1,
      "name": "Ruleset Name",
      "min_quantity": 1,
      "max_quantity": 2,
      "cta_text": "Add to cart",
      "products": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "plans": [
    {
      "id": 1,
      "pricing": {},
      "plan": {},
      "variant": {},
      "pricings": [
        {}
      ],
      "variants": [
        {}
      ],
      "prices": [
        {}
      ],
      "discounts": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "preferences": [
    {
      "id": 1,
      "title": "Do you want only vageterian dishes?",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "filters": [
    {
      "id": 1,
      "title": "Type of dish",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "tags": [
    "new",
    "bundle"
  ],
  "tags_meta": [
    {
      "id": 1,
      "value": "new"
    },
    {
      "id": 2,
      "value": "bundle"
    }
  ],
  "setup_fee": 500,
  "gifting_enabled": false,
  "pause_enabled": false,
  "pre_order_end_at": "2024-12-31",
  "funnel_id": 1,
  "change_product_collection_id": 1,
  "collect_shipping_address": true,
  "published": true,
  "items_count": 5,
  "plans_count": 2,
  "rulesets_count": 1,
  "metadata": [
    {
      "id": 1,
      "name": "Color",
      "slug": "color-red",
      "description": "description",
      "unit": "kg",
      "data_type": "single_line_string",
      "preset": true,
      "multiple": true,
      "variant": true,
      "access_level": "storefront",
      "save_behavior": "customer",
      "editable": true,
      "values": [
        {}
      ]
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Update a bundle

PUT /bundles/{bundle_id}

This operation accepts no expand parameter, so the relation fields of the returned bundle are always empty. Read the bundle back with expand to see them.

Path parameters

bundle_idRequiredinteger

Bundle ID

Request body

slugoptionalstring

Must be unique among the shop's bundles.

nameoptionalstring

hidden_itemsoptionalinteger

Possible values: 0, 1.

searchableoptionalinteger

Possible values: 0, 1.

show_ruleset_nameoptionalinteger

Prohibited unless the bundle is configurable.

Possible values: 0, 1.

descriptionoptionalstring | null

delivery_infooptionalstring | null

setup_feeoptionalinteger | null

pre_order_end_atoptionalstring | null

Date in Y-m-d format. Must be today or later; past dates are rejected.

Format: date.

gifting_enabledoptionalinteger

Prohibited when the bundle is digital.

Possible values: 0, 1.

pause_enabledoptionalinteger

0 is only accepted on plans with the optional-pause feature; other shops must send 1.

Possible values: 0, 1.

price_typeoptionalstring | null

Must be present in the payload whenever discount_type or ruleset_type is sent (send null if not applicable). Only accepted for configurable bundles; rejected when selection_type is single_product, when ruleset_type is total, or when discount_type is also non-null.

Possible values: total, per_item.

discount_typeoptionalstring | null

Must be present in the payload whenever price_type is sent (send null if not applicable). Only accepted for configurable bundles; rejected when price_type is also non-null (except for single_product bundles).

Possible values: per_item, total, percentage.

ruleset_typeoptionalstring

Only accepted for configurable bundles whose selection_type is not single_product. Rejected while the bundle has active subscriptions.

Possible values: quantity, total.

appearance_typeoptionalstring

Only accepted for configurable bundles whose selection_type is not single_product.

Possible values: one_step, two_step, without_ruleset.

quantity_selectorsoptionalinteger[] | null

Only accepted when the bundle is configurable and its selection_type is not single_product. Must be a JSON list, not an object.

collect_shipping_addressoptionalinteger

Must be 1 unless the bundle is digital; 0 is only accepted for digital bundles.

Possible values: 0, 1.

funnel_idoptionalinteger | null

change_product_collection_idoptionalinteger | null

ID of the product collection used for cross-product plan switching. Must be a non-archived collection of the shop whose type is 'subscription' or unset.

tagsoptionalobject

createoptionalobject[]

deleteoptionalobject[]

filtersoptionalobject

Only accepted when the bundle is configurable and its selection_type is not single_product.

createoptionalobject[]

A bundle may hold only one filter in total, so delete the existing filter in the same request before creating a new one.

deleteoptionalobject[]

preferencesoptionalobject

Only accepted when the bundle is configurable and its selection_type is not single_product.

createoptionalobject[]

updateoptionalobject[]

deleteoptionalobject[]

rulesetsoptionalobject

Prohibited when the bundle is not configurable or its selection_type is single_product, and prohibited in the same request as ruleset_type; change the ruleset type in a separate call. After create, update and delete are applied the resulting set must hold at least one ruleset and must satisfy the range rules for the bundle's ruleset_type.

createoptionalobject[]

Judged against the final set after create, update and delete are applied. Each min must be less than or equal to max (max null means unbounded) and mins must be distinct. For ruleset_type=quantity the ranges must not overlap. For ruleset_type=total the ranges must be contiguous: the lowest must start at 0, each next min must equal the previous max plus 1, and the highest must have max null.

updateoptionalobject[]

Ids must belong to this bundle, must not be archived and must be distinct.

deleteoptionalobject[]

Ids must belong to this bundle, must not be archived and must be distinct. At least one active ruleset must remain after the request, and a ruleset with active subscriptions cannot be deleted.

imagesoptionalobject

createoptionalobject[]

The bundle total after deletes and creates must not exceed 5 images.

updateoptionalobject[]

deleteoptionalobject[]

ReturnsBundle

Bundle object response

idinteger

namestring

slugstring

digitalboolean

delivery_infostring | null

configurableboolean

imagesProductImage[]

descriptionstring | null

hidden_itemsboolean

searchableboolean

show_ruleset_nameboolean

quantity_selectorsinteger[] | null

selection_typestring | null

Possible values: variant, product, single_product.

discount_typestring | null

Possible values: per_item, total, percentage.

price_typestring | null

Possible values: per_item, total.

ruleset_typestring | null

Possible values: total, quantity.

appearance_typestring | null

Possible values: one_step, two_step, without_ruleset, after_checkout.

rulesetsBundleRuleset[]

plansBundlePlan[]

preferencesBundlePreference[]

filtersBundleFilter[]

discountsBundleDiscount[]

pricesBundlePrice[]

tagsstring[]

tags_metaobject[]

setup_feeinteger | null

gifting_enabledboolean

pause_enabledboolean

pre_order_end_atstring | null

Format: date.

funnel_idinteger | null

change_product_collection_idinteger | null

ID of the product collection used for cross-product plan switching.

collect_shipping_addressboolean

publishedboolean

items_countinteger

plans_countinteger

rulesets_countinteger

metadataEntityMetadata[] | null

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl -X PUT https://api.subbly.co/private/v1/bundles/{bundle_id} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "slug": "slug",
  "name": "name",
  "hidden_items": 0,
  "searchable": 0,
  "show_ruleset_name": 0,
  "description": "description",
  "delivery_info": "delivery_info",
  "setup_fee": 0,
  "pre_order_end_at": "2026-01-15",
  "gifting_enabled": 0,
  "pause_enabled": 0,
  "price_type": "total",
  "discount_type": "per_item",
  "ruleset_type": "quantity",
  "appearance_type": "one_step",
  "quantity_selectors": [
    1
  ],
  "collect_shipping_address": 0,
  "funnel_id": 1,
  "change_product_collection_id": 1,
  "tags": {
    "create": [
      {
        "value": "value"
      }
    ],
    "delete": [
      {
        "id": 1
      }
    ]
  },
  "filters": {
    "create": [
      {
        "metadata_id": 1
      }
    ],
    "delete": [
      {
        "metadata_id": 1
      }
    ]
  },
  "preferences": {
    "create": [
      {
        "attribute_id": 1,
        "title": "title"
      }
    ],
    "update": [
      {
        "id": 1,
        "title": "title"
      }
    ],
    "delete": [
      {
        "id": 1
      }
    ]
  },
  "rulesets": {
    "create": [
      {
        "min": 0,
        "max": 1,
        "name": "name",
        "cta_text": "cta_text"
      }
    ],
    "update": [
      {
        "id": 1,
        "min": 0,
        "max": 1,
        "name": "name",
        "cta_text": "cta_text"
      }
    ],
    "delete": [
      {
        "id": 1
      }
    ]
  },
  "images": {
    "create": [
      {
        "url": "url",
        "order": 0
      }
    ],
    "update": [
      {
        "id": 1,
        "order": 0
      }
    ],
    "delete": [
      {
        "id": 1
      }
    ]
  }
}'

Response

{
  "id": 1,
  "name": "Bundle Name",
  "slug": "Bundle slug",
  "digital": false,
  "delivery_info": "delivery_info",
  "configurable": true,
  "images": [
    {
      "id": 1,
      "url": "https://cdn.filestackcontent.com/security=p:<policy>,s:<signature>/resize=w:1000,h:1000,fit:max/output=format:png/quality=v:70/AaBbCcDdEeFf",
      "order": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "description": "description",
  "hidden_items": true,
  "searchable": false,
  "show_ruleset_name": false,
  "quantity_selectors": [
    1
  ],
  "selection_type": "variant",
  "discount_type": "per_item",
  "price_type": "per_item",
  "ruleset_type": "total",
  "appearance_type": "one_step",
  "rulesets": [
    {
      "id": 1,
      "name": "Ruleset Name",
      "min_quantity": 1,
      "max_quantity": 2,
      "cta_text": "Add to cart",
      "products": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "plans": [
    {
      "id": 1,
      "pricing": {},
      "plan": {},
      "variant": {},
      "pricings": [
        {}
      ],
      "variants": [
        {}
      ],
      "prices": [
        {}
      ],
      "discounts": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "preferences": [
    {
      "id": 1,
      "title": "Do you want only vageterian dishes?",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "filters": [
    {
      "id": 1,
      "title": "Type of dish",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "tags": [
    "new",
    "bundle"
  ],
  "tags_meta": [
    {
      "id": 1,
      "value": "new"
    },
    {
      "id": 2,
      "value": "bundle"
    }
  ],
  "setup_fee": 500,
  "gifting_enabled": false,
  "pause_enabled": false,
  "pre_order_end_at": "2024-12-31",
  "funnel_id": 1,
  "change_product_collection_id": 1,
  "collect_shipping_address": true,
  "published": true,
  "items_count": 5,
  "plans_count": 2,
  "rulesets_count": 1,
  "metadata": [
    {
      "id": 1,
      "name": "Color",
      "slug": "color-red",
      "description": "description",
      "unit": "kg",
      "data_type": "single_line_string",
      "preset": true,
      "multiple": true,
      "variant": true,
      "access_level": "storefront",
      "save_behavior": "customer",
      "editable": true,
      "values": [
        {}
      ]
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Get list of bundle items

GET /bundles/{bundle_id}/items

An API endpoint to get list of items within a bundle.

Path parameters

bundle_idRequiredinteger

Bundle ID

Query parameters

pageoptionalinteger

Page number for pagination

Defaults to 1.

per_pageoptionalinteger

Items per page

Defaults to 10.

filters[]optionalobject[]

Filter by metadata. A list of filter objects. Only preset metadata with single_line_string data type can be used for filtering.

metafield_idoptionalinteger

Filter by metadata ID. Only preset metadata with single_line_string data type are supported. Required unless attribute_id is given.

attribute_idoptionalinteger

Alias for metafield_id. Required unless metafield_id is given.

valuesRequiredinteger[]

Metadata value IDs to filter by. Each ID must exist.

variant_ids[]optionalinteger[]

Filter by variant IDs

queryoptionalstring

Search query for bundle items

expand[]optionalstring[]

List of relations to expand in the response.

Returnsobject

Bundle items list response

paginationobject

dataBundleItem[]

curl https://api.subbly.co/private/v1/bundles/{bundle_id}/items \
  -H 'X-API-KEY: <api-key>'

Response

{
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "from": 1,
    "to": 1,
    "total": 20
  },
  "data": [
    {
      "id": 1,
      "product_id": 1,
      "bundle_id": 1,
      "product": {
        "id": 1,
        "bundle_plan_id": 1,
        "bundle_plan": {},
        "name": "Yellow T-shirt with pokemon print",
        "description": "Yellow T-shirt with pokemon print",
        "price": 799,
        "price_schema": {},
        "price_scheme": {},
        "parent": {},
        "product": {},
        "metadata": [
          {}
        ],
        "attributes": [
          {}
        ],
        "options": [
          {}
        ],
        "stock_count": 100,
        "published": true,
        "inventory_item_id": 1,
        "created_at": "2022-04-01 00:00:00",
        "updated_at": "2022-04-01 00:00:00"
      },
      "variant_id": 1,
      "variant": {
        "id": 1,
        "bundle_plan_id": 1,
        "bundle_plan": {},
        "name": "Yellow T-shirt with pokemon print",
        "description": "Yellow T-shirt with pokemon print",
        "price": 799,
        "price_schema": {},
        "price_scheme": {},
        "parent": {},
        "product": {},
        "metadata": [
          {}
        ],
        "attributes": [
          {}
        ],
        "options": [
          {}
        ],
        "stock_count": 100,
        "published": true,
        "inventory_item_id": 1,
        "created_at": "2022-04-01 00:00:00",
        "updated_at": "2022-04-01 00:00:00"
      },
      "settings": [
        {
          "id": 1,
          "ruleset_id": 1,
          "max_quantity": 1,
          "created_at": "2026-01-15T10:30:00Z",
          "updated_at": "2026-01-15T10:30:00Z"
        }
      ],
      "extra_price": 1,
      "stock_count": 1,
      "quantity": 1,
      "position": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ]
}

Create a bundle item

POST /bundles/{bundle_id}/items

Path parameters

bundle_idRequiredinteger

Bundle ID

Request body

variant_idRequiredinteger

Product variant ID to add. Must be a non-archived one-time product variant belonging to the shop (not a gift card, not a bundle), and must not already be an item of this bundle.

quantityoptionalinteger | null

Prohibited when the bundle is configurable; sending it returns 422 "Quantity is not available for configurable bundles."

positionoptionalinteger | null

extra_priceoptionalinteger | null

Extra price in cents. Only available for configurable bundles; sending it on a non-configurable bundle returns 422 "Extra price is only available for configurable bundles."

settingsoptionalobject | null

Only available for configurable bundles whose selection type is not "single"; sending it otherwise returns 422.

createoptionalobject[]

ReturnsBundleItem

Bundle item created successfully

idinteger

product_idintegerDeprecated

Deprecated. Use variant_id instead.

bundle_idinteger

productVariant | nullDeprecated

Expandable link to the variant. Null unless requested via expand.

variant_idinteger

variantVariant | null

Expandable link to the variant. Null unless requested via expand.

settingsBundleItemSetting[]

extra_priceinteger | null

Additional price for this bundle item

stock_countinteger | null

Available stock for this item

quantityinteger | null

Quantity of this item in the bundle. Always null on configurable bundles.

positioninteger | null

Display position of this item. Null when never set.

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl -X POST https://api.subbly.co/private/v1/bundles/{bundle_id}/items \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "variant_id": 1,
  "quantity": 1,
  "position": 1,
  "extra_price": 0,
  "settings": {
    "create": [
      {
        "bundle_ruleset_id": 1,
        "max_quantity": 1
      }
    ]
  }
}'

Response

{
  "id": 1,
  "product_id": 1,
  "bundle_id": 1,
  "product": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "variant_id": 1,
  "variant": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "settings": [
    {
      "id": 1,
      "ruleset_id": 1,
      "max_quantity": 1,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "extra_price": 1,
  "stock_count": 1,
  "quantity": 1,
  "position": 1,
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Batch create bundle items

POST /bundles/{bundle_id}/items/batch

Path parameters

bundle_idRequiredinteger

Bundle ID

Request body

createRequiredobject[]

variant_idRequiredinteger

Product variant ID. Must be a non-archived one-time product variant belonging to the shop (not a gift card, not a bundle), must not already be an item of this bundle, and must not repeat within the same create array.

quantityoptionalinteger | null

Prohibited when the bundle is configurable; sending it returns 422 "Quantity is not available for configurable bundles."

positionoptionalinteger | null

extra_priceoptionalinteger | null

Extra price in cents. Only available for configurable bundles; sending it on a non-configurable bundle returns 422 "Extra price is only available for configurable bundles."

settingsoptionalobject | null

Only available for configurable bundles whose selection type is not "single"; sending it otherwise returns 422.

Returnsobject

Batch bundle items created successfully

createBundleItem[]

curl -X POST https://api.subbly.co/private/v1/bundles/{bundle_id}/items/batch \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "create": [
    {
      "variant_id": 1,
      "quantity": 1,
      "position": 1,
      "extra_price": 0,
      "settings": {
        "create": [
          {
            "bundle_ruleset_id": 1,
            "max_quantity": 1
          }
        ]
      }
    }
  ]
}'

Response

{
  "create": [
    {
      "id": 1,
      "product_id": 1,
      "bundle_id": 1,
      "product": {
        "id": 1,
        "bundle_plan_id": 1,
        "bundle_plan": {},
        "name": "Yellow T-shirt with pokemon print",
        "description": "Yellow T-shirt with pokemon print",
        "price": 799,
        "price_schema": {},
        "price_scheme": {},
        "parent": {},
        "product": {},
        "metadata": [
          {}
        ],
        "attributes": [
          {}
        ],
        "options": [
          {}
        ],
        "stock_count": 100,
        "published": true,
        "inventory_item_id": 1,
        "created_at": "2022-04-01 00:00:00",
        "updated_at": "2022-04-01 00:00:00"
      },
      "variant_id": 1,
      "variant": {
        "id": 1,
        "bundle_plan_id": 1,
        "bundle_plan": {},
        "name": "Yellow T-shirt with pokemon print",
        "description": "Yellow T-shirt with pokemon print",
        "price": 799,
        "price_schema": {},
        "price_scheme": {},
        "parent": {},
        "product": {},
        "metadata": [
          {}
        ],
        "attributes": [
          {}
        ],
        "options": [
          {}
        ],
        "stock_count": 100,
        "published": true,
        "inventory_item_id": 1,
        "created_at": "2022-04-01 00:00:00",
        "updated_at": "2022-04-01 00:00:00"
      },
      "settings": [
        {
          "id": 1,
          "ruleset_id": 1,
          "max_quantity": 1,
          "created_at": "2026-01-15T10:30:00Z",
          "updated_at": "2026-01-15T10:30:00Z"
        }
      ],
      "extra_price": 1,
      "stock_count": 1,
      "quantity": 1,
      "position": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ]
}

Get bundle item by ID

GET /bundles/{bundle_id}/items/{item_id}

Get a specific bundle item by ID.

Path parameters

bundle_idRequiredinteger

Bundle ID

item_idRequiredinteger

Bundle item ID

Query parameters

expand[]optionalstring[]

List of relations to expand in the response.

ReturnsBundleItem

Bundle item object response

idinteger

product_idintegerDeprecated

Deprecated. Use variant_id instead.

bundle_idinteger

productVariant | nullDeprecated

Expandable link to the variant. Null unless requested via expand.

variant_idinteger

variantVariant | null

Expandable link to the variant. Null unless requested via expand.

settingsBundleItemSetting[]

extra_priceinteger | null

Additional price for this bundle item

stock_countinteger | null

Available stock for this item

quantityinteger | null

Quantity of this item in the bundle. Always null on configurable bundles.

positioninteger | null

Display position of this item. Null when never set.

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl https://api.subbly.co/private/v1/bundles/{bundle_id}/items/{item_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "product_id": 1,
  "bundle_id": 1,
  "product": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "variant_id": 1,
  "variant": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "settings": [
    {
      "id": 1,
      "ruleset_id": 1,
      "max_quantity": 1,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "extra_price": 1,
  "stock_count": 1,
  "quantity": 1,
  "position": 1,
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Update a bundle item

PUT /bundles/{bundle_id}/items/{item_id}

Path parameters

bundle_idRequiredinteger

Bundle ID

item_idRequiredinteger

Bundle item ID

Request body

quantityoptionalinteger | null

Prohibited when the bundle is configurable; sending it returns 422 "Quantity is not available for configurable bundles."

positionoptionalinteger | null

extra_priceoptionalinteger | null

Extra price in cents. Only available for configurable bundles; sending it on a non-configurable bundle returns 422 "Extra price is only available for configurable bundles."

settingsoptionalobject

Only available for configurable bundles whose selection type is not "single"; sending it otherwise returns 422.

createoptionalobject[]

updateoptionalobject[]

deleteoptionalobject[]

ReturnsBundleItem

Bundle item object response

idinteger

product_idintegerDeprecated

Deprecated. Use variant_id instead.

bundle_idinteger

productVariant | nullDeprecated

Expandable link to the variant. Null unless requested via expand.

variant_idinteger

variantVariant | null

Expandable link to the variant. Null unless requested via expand.

settingsBundleItemSetting[]

extra_priceinteger | null

Additional price for this bundle item

stock_countinteger | null

Available stock for this item

quantityinteger | null

Quantity of this item in the bundle. Always null on configurable bundles.

positioninteger | null

Display position of this item. Null when never set.

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl -X PUT https://api.subbly.co/private/v1/bundles/{bundle_id}/items/{item_id} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "quantity": 1,
  "position": 1,
  "extra_price": 0,
  "settings": {
    "create": [
      {
        "bundle_ruleset_id": 1,
        "max_quantity": 1
      }
    ],
    "update": [
      {
        "id": 1,
        "max_quantity": 1
      }
    ],
    "delete": [
      {
        "id": 1
      }
    ]
  }
}'

Response

{
  "id": 1,
  "product_id": 1,
  "bundle_id": 1,
  "product": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "variant_id": 1,
  "variant": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "settings": [
    {
      "id": 1,
      "ruleset_id": 1,
      "max_quantity": 1,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "extra_price": 1,
  "stock_count": 1,
  "quantity": 1,
  "position": 1,
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Delete a bundle item

DELETE /bundles/{bundle_id}/items/{item_id}

Deleting is refused with 400 minimum_items_required when the bundle currently has fewer than 2 items. A bundle must keep at least 2 items.

Path parameters

bundle_idRequiredinteger

Bundle ID

item_idRequiredinteger

Bundle item ID

ReturnsBundleItem

Bundle item deleted

idinteger

product_idintegerDeprecated

Deprecated. Use variant_id instead.

bundle_idinteger

productVariant | nullDeprecated

Expandable link to the variant. Null unless requested via expand.

variant_idinteger

variantVariant | null

Expandable link to the variant. Null unless requested via expand.

settingsBundleItemSetting[]

extra_priceinteger | null

Additional price for this bundle item

stock_countinteger | null

Available stock for this item

quantityinteger | null

Quantity of this item in the bundle. Always null on configurable bundles.

positioninteger | null

Display position of this item. Null when never set.

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

Error responses

400any

minimum_items_required. The bundle must keep at least 2 items.

curl -X DELETE https://api.subbly.co/private/v1/bundles/{bundle_id}/items/{item_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "product_id": 1,
  "bundle_id": 1,
  "product": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "variant_id": 1,
  "variant": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "settings": [
    {
      "id": 1,
      "ruleset_id": 1,
      "max_quantity": 1,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "extra_price": 1,
  "stock_count": 1,
  "quantity": 1,
  "position": 1,
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Get list of bundle groups

GET /bundles/{bundle_id}/groups

An API endpoint to get list of groups within a bundle.

Path parameters

bundle_idRequiredinteger

Bundle ID

Query parameters

expand[]optionalstring[]

List of relations to expand. items is always present and does not need to be requested. Available keys: product (the parent product of the group). Nested paths are supported, e.g. product.variants. Unknown keys are ignored.

pageoptionalinteger

Page number for pagination

Defaults to 1.

per_pageoptionalinteger

Items per page

Defaults to 10.

Returnsobject

Bundle groups list response

paginationobject

dataBundleGroup[]

Error responses

400object

The bundle is archived.

404object

Bundle not found, or it belongs to another shop.

curl https://api.subbly.co/private/v1/bundles/{bundle_id}/groups \
  -H 'X-API-KEY: <api-key>'

Response

{
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "from": 1,
    "to": 1,
    "total": 20
  },
  "data": [
    {
      "id": 1,
      "bundle_id": 1,
      "name": "Main Items",
      "description": "Select your main items",
      "position": 1,
      "product_id": 10,
      "product": {
        "id": 1,
        "bundle_id": 1,
        "bundle": {},
        "bundle_ruleset_id": 1,
        "bundle_ruleset": {},
        "slug": "yellow-t-shirt-with-pokemon-print",
        "type": "one_time",
        "name": "Yellow T-shirt with pokemon print",
        "description": "Yellow T-shirt with pokemon print",
        "delivery_info": "Free shipping on orders over $100",
        "collect_shipping_address": true,
        "gifting_enabled": true,
        "digital": false,
        "images": [
          {}
        ],
        "tags": [
          "new",
          "featured"
        ],
        "tags_meta": [
          {
            "id": 1,
            "value": "new"
          },
          {
            "id": 2,
            "value": "featured"
          }
        ],
        "published": true,
        "metadata": [
          {}
        ],
        "created_at": "2022-04-01 00:00:00",
        "updated_at": "2022-04-01 00:00:00"
      },
      "min_quantity": 1,
      "max_quantity": 3,
      "items": [
        {
          "id": 1,
          "product_id": 1,
          "bundle_id": 1,
          "product": {},
          "variant_id": 1,
          "variant": {},
          "settings": [
            {}
          ],
          "extra_price": 1,
          "stock_count": 1,
          "quantity": 1,
          "position": 1,
          "created_at": "2022-04-01 00:00:00",
          "updated_at": "2022-04-01 00:00:00"
        }
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ]
}

Publish a bundle

POST /bundles/{bundle_id}/publish

Path parameters

bundle_idRequiredinteger

Bundle ID

ReturnsBundle

Bundle object response

idinteger

namestring

slugstring

digitalboolean

delivery_infostring | null

configurableboolean

imagesProductImage[]

descriptionstring | null

hidden_itemsboolean

searchableboolean

show_ruleset_nameboolean

quantity_selectorsinteger[] | null

selection_typestring | null

Possible values: variant, product, single_product.

discount_typestring | null

Possible values: per_item, total, percentage.

price_typestring | null

Possible values: per_item, total.

ruleset_typestring | null

Possible values: total, quantity.

appearance_typestring | null

Possible values: one_step, two_step, without_ruleset, after_checkout.

rulesetsBundleRuleset[]

plansBundlePlan[]

preferencesBundlePreference[]

filtersBundleFilter[]

discountsBundleDiscount[]

pricesBundlePrice[]

tagsstring[]

tags_metaobject[]

setup_feeinteger | null

gifting_enabledboolean

pause_enabledboolean

pre_order_end_atstring | null

Format: date.

funnel_idinteger | null

change_product_collection_idinteger | null

ID of the product collection used for cross-product plan switching.

collect_shipping_addressboolean

publishedboolean

items_countinteger

plans_countinteger

rulesets_countinteger

metadataEntityMetadata[] | null

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

Error responses

400object

The bundle is archived, is already published, has no items, or has no active (non-archived) plans.

curl -X POST https://api.subbly.co/private/v1/bundles/{bundle_id}/publish \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "name": "Bundle Name",
  "slug": "Bundle slug",
  "digital": false,
  "delivery_info": "delivery_info",
  "configurable": true,
  "images": [
    {
      "id": 1,
      "url": "https://cdn.filestackcontent.com/security=p:<policy>,s:<signature>/resize=w:1000,h:1000,fit:max/output=format:png/quality=v:70/AaBbCcDdEeFf",
      "order": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "description": "description",
  "hidden_items": true,
  "searchable": false,
  "show_ruleset_name": false,
  "quantity_selectors": [
    1
  ],
  "selection_type": "variant",
  "discount_type": "per_item",
  "price_type": "per_item",
  "ruleset_type": "total",
  "appearance_type": "one_step",
  "rulesets": [
    {
      "id": 1,
      "name": "Ruleset Name",
      "min_quantity": 1,
      "max_quantity": 2,
      "cta_text": "Add to cart",
      "products": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "plans": [
    {
      "id": 1,
      "pricing": {},
      "plan": {},
      "variant": {},
      "pricings": [
        {}
      ],
      "variants": [
        {}
      ],
      "prices": [
        {}
      ],
      "discounts": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "preferences": [
    {
      "id": 1,
      "title": "Do you want only vageterian dishes?",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "filters": [
    {
      "id": 1,
      "title": "Type of dish",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "tags": [
    "new",
    "bundle"
  ],
  "tags_meta": [
    {
      "id": 1,
      "value": "new"
    },
    {
      "id": 2,
      "value": "bundle"
    }
  ],
  "setup_fee": 500,
  "gifting_enabled": false,
  "pause_enabled": false,
  "pre_order_end_at": "2024-12-31",
  "funnel_id": 1,
  "change_product_collection_id": 1,
  "collect_shipping_address": true,
  "published": true,
  "items_count": 5,
  "plans_count": 2,
  "rulesets_count": 1,
  "metadata": [
    {
      "id": 1,
      "name": "Color",
      "slug": "color-red",
      "description": "description",
      "unit": "kg",
      "data_type": "single_line_string",
      "preset": true,
      "multiple": true,
      "variant": true,
      "access_level": "storefront",
      "save_behavior": "customer",
      "editable": true,
      "values": [
        {}
      ]
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Unpublish a bundle

POST /bundles/{bundle_id}/unpublish

Path parameters

bundle_idRequiredinteger

Bundle ID

ReturnsBundle

Bundle object response

idinteger

namestring

slugstring

digitalboolean

delivery_infostring | null

configurableboolean

imagesProductImage[]

descriptionstring | null

hidden_itemsboolean

searchableboolean

show_ruleset_nameboolean

quantity_selectorsinteger[] | null

selection_typestring | null

Possible values: variant, product, single_product.

discount_typestring | null

Possible values: per_item, total, percentage.

price_typestring | null

Possible values: per_item, total.

ruleset_typestring | null

Possible values: total, quantity.

appearance_typestring | null

Possible values: one_step, two_step, without_ruleset, after_checkout.

rulesetsBundleRuleset[]

plansBundlePlan[]

preferencesBundlePreference[]

filtersBundleFilter[]

discountsBundleDiscount[]

pricesBundlePrice[]

tagsstring[]

tags_metaobject[]

setup_feeinteger | null

gifting_enabledboolean

pause_enabledboolean

pre_order_end_atstring | null

Format: date.

funnel_idinteger | null

change_product_collection_idinteger | null

ID of the product collection used for cross-product plan switching.

collect_shipping_addressboolean

publishedboolean

items_countinteger

plans_countinteger

rulesets_countinteger

metadataEntityMetadata[] | null

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

Error responses

400object

The bundle is archived, or is not currently published.

curl -X POST https://api.subbly.co/private/v1/bundles/{bundle_id}/unpublish \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "name": "Bundle Name",
  "slug": "Bundle slug",
  "digital": false,
  "delivery_info": "delivery_info",
  "configurable": true,
  "images": [
    {
      "id": 1,
      "url": "https://cdn.filestackcontent.com/security=p:<policy>,s:<signature>/resize=w:1000,h:1000,fit:max/output=format:png/quality=v:70/AaBbCcDdEeFf",
      "order": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "description": "description",
  "hidden_items": true,
  "searchable": false,
  "show_ruleset_name": false,
  "quantity_selectors": [
    1
  ],
  "selection_type": "variant",
  "discount_type": "per_item",
  "price_type": "per_item",
  "ruleset_type": "total",
  "appearance_type": "one_step",
  "rulesets": [
    {
      "id": 1,
      "name": "Ruleset Name",
      "min_quantity": 1,
      "max_quantity": 2,
      "cta_text": "Add to cart",
      "products": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "plans": [
    {
      "id": 1,
      "pricing": {},
      "plan": {},
      "variant": {},
      "pricings": [
        {}
      ],
      "variants": [
        {}
      ],
      "prices": [
        {}
      ],
      "discounts": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "preferences": [
    {
      "id": 1,
      "title": "Do you want only vageterian dishes?",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "filters": [
    {
      "id": 1,
      "title": "Type of dish",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "tags": [
    "new",
    "bundle"
  ],
  "tags_meta": [
    {
      "id": 1,
      "value": "new"
    },
    {
      "id": 2,
      "value": "bundle"
    }
  ],
  "setup_fee": 500,
  "gifting_enabled": false,
  "pause_enabled": false,
  "pre_order_end_at": "2024-12-31",
  "funnel_id": 1,
  "change_product_collection_id": 1,
  "collect_shipping_address": true,
  "published": true,
  "items_count": 5,
  "plans_count": 2,
  "rulesets_count": 1,
  "metadata": [
    {
      "id": 1,
      "name": "Color",
      "slug": "color-red",
      "description": "description",
      "unit": "kg",
      "data_type": "single_line_string",
      "preset": true,
      "multiple": true,
      "variant": true,
      "access_level": "storefront",
      "save_behavior": "customer",
      "editable": true,
      "values": [
        {}
      ]
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Archive a bundle

POST /bundles/{bundle_id}/archive

Path parameters

bundle_idRequiredinteger

Bundle ID

ReturnsBundle

Bundle object response

idinteger

namestring

slugstring

digitalboolean

delivery_infostring | null

configurableboolean

imagesProductImage[]

descriptionstring | null

hidden_itemsboolean

searchableboolean

show_ruleset_nameboolean

quantity_selectorsinteger[] | null

selection_typestring | null

Possible values: variant, product, single_product.

discount_typestring | null

Possible values: per_item, total, percentage.

price_typestring | null

Possible values: per_item, total.

ruleset_typestring | null

Possible values: total, quantity.

appearance_typestring | null

Possible values: one_step, two_step, without_ruleset, after_checkout.

rulesetsBundleRuleset[]

plansBundlePlan[]

preferencesBundlePreference[]

filtersBundleFilter[]

discountsBundleDiscount[]

pricesBundlePrice[]

tagsstring[]

tags_metaobject[]

setup_feeinteger | null

gifting_enabledboolean

pause_enabledboolean

pre_order_end_atstring | null

Format: date.

funnel_idinteger | null

change_product_collection_idinteger | null

ID of the product collection used for cross-product plan switching.

collect_shipping_addressboolean

publishedboolean

items_countinteger

plans_countinteger

rulesets_countinteger

metadataEntityMetadata[] | null

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

Error responses

400object

The bundle is already archived, or still has active subscriptions.

curl -X POST https://api.subbly.co/private/v1/bundles/{bundle_id}/archive \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "name": "Bundle Name",
  "slug": "Bundle slug",
  "digital": false,
  "delivery_info": "delivery_info",
  "configurable": true,
  "images": [
    {
      "id": 1,
      "url": "https://cdn.filestackcontent.com/security=p:<policy>,s:<signature>/resize=w:1000,h:1000,fit:max/output=format:png/quality=v:70/AaBbCcDdEeFf",
      "order": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "description": "description",
  "hidden_items": true,
  "searchable": false,
  "show_ruleset_name": false,
  "quantity_selectors": [
    1
  ],
  "selection_type": "variant",
  "discount_type": "per_item",
  "price_type": "per_item",
  "ruleset_type": "total",
  "appearance_type": "one_step",
  "rulesets": [
    {
      "id": 1,
      "name": "Ruleset Name",
      "min_quantity": 1,
      "max_quantity": 2,
      "cta_text": "Add to cart",
      "products": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "plans": [
    {
      "id": 1,
      "pricing": {},
      "plan": {},
      "variant": {},
      "pricings": [
        {}
      ],
      "variants": [
        {}
      ],
      "prices": [
        {}
      ],
      "discounts": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "preferences": [
    {
      "id": 1,
      "title": "Do you want only vageterian dishes?",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "filters": [
    {
      "id": 1,
      "title": "Type of dish",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "tags": [
    "new",
    "bundle"
  ],
  "tags_meta": [
    {
      "id": 1,
      "value": "new"
    },
    {
      "id": 2,
      "value": "bundle"
    }
  ],
  "setup_fee": 500,
  "gifting_enabled": false,
  "pause_enabled": false,
  "pre_order_end_at": "2024-12-31",
  "funnel_id": 1,
  "change_product_collection_id": 1,
  "collect_shipping_address": true,
  "published": true,
  "items_count": 5,
  "plans_count": 2,
  "rulesets_count": 1,
  "metadata": [
    {
      "id": 1,
      "name": "Color",
      "slug": "color-red",
      "description": "description",
      "unit": "kg",
      "data_type": "single_line_string",
      "preset": true,
      "multiple": true,
      "variant": true,
      "access_level": "storefront",
      "save_behavior": "customer",
      "editable": true,
      "values": [
        {}
      ]
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Sync bundle metadata

POST /bundles/{bundle_id}/metadata

Attaches and detaches metadata on the bundle. The bundle must not be archived, otherwise the request returns 400 (entity_archived).

Path parameters

bundle_idRequiredinteger

Bundle ID

Request body

Metadata sync request body

metadataRequiredobject

createoptionalobject[] | null

deleteoptionalobject[] | null

ReturnsBundle

Bundle object response

idinteger

namestring

slugstring

digitalboolean

delivery_infostring | null

configurableboolean

imagesProductImage[]

descriptionstring | null

hidden_itemsboolean

searchableboolean

show_ruleset_nameboolean

quantity_selectorsinteger[] | null

selection_typestring | null

Possible values: variant, product, single_product.

discount_typestring | null

Possible values: per_item, total, percentage.

price_typestring | null

Possible values: per_item, total.

ruleset_typestring | null

Possible values: total, quantity.

appearance_typestring | null

Possible values: one_step, two_step, without_ruleset, after_checkout.

rulesetsBundleRuleset[]

plansBundlePlan[]

preferencesBundlePreference[]

filtersBundleFilter[]

discountsBundleDiscount[]

pricesBundlePrice[]

tagsstring[]

tags_metaobject[]

setup_feeinteger | null

gifting_enabledboolean

pause_enabledboolean

pre_order_end_atstring | null

Format: date.

funnel_idinteger | null

change_product_collection_idinteger | null

ID of the product collection used for cross-product plan switching.

collect_shipping_addressboolean

publishedboolean

items_countinteger

plans_countinteger

rulesets_countinteger

metadataEntityMetadata[] | null

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl -X POST https://api.subbly.co/private/v1/bundles/{bundle_id}/metadata \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "metadata": {
    "create": [
      {
        "name": "name",
        "description": "description",
        "values": [
          "values"
        ]
      }
    ],
    "delete": [
      {
        "attribute_id": 1,
        "values": [
          1
        ]
      }
    ]
  }
}'

Response

{
  "id": 1,
  "name": "Bundle Name",
  "slug": "Bundle slug",
  "digital": false,
  "delivery_info": "delivery_info",
  "configurable": true,
  "images": [
    {
      "id": 1,
      "url": "https://cdn.filestackcontent.com/security=p:<policy>,s:<signature>/resize=w:1000,h:1000,fit:max/output=format:png/quality=v:70/AaBbCcDdEeFf",
      "order": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "description": "description",
  "hidden_items": true,
  "searchable": false,
  "show_ruleset_name": false,
  "quantity_selectors": [
    1
  ],
  "selection_type": "variant",
  "discount_type": "per_item",
  "price_type": "per_item",
  "ruleset_type": "total",
  "appearance_type": "one_step",
  "rulesets": [
    {
      "id": 1,
      "name": "Ruleset Name",
      "min_quantity": 1,
      "max_quantity": 2,
      "cta_text": "Add to cart",
      "products": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "plans": [
    {
      "id": 1,
      "pricing": {},
      "plan": {},
      "variant": {},
      "pricings": [
        {}
      ],
      "variants": [
        {}
      ],
      "prices": [
        {}
      ],
      "discounts": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "preferences": [
    {
      "id": 1,
      "title": "Do you want only vageterian dishes?",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "filters": [
    {
      "id": 1,
      "title": "Type of dish",
      "attribute_id": 1,
      "metafield_id": 1,
      "values": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "tags": [
    "new",
    "bundle"
  ],
  "tags_meta": [
    {
      "id": 1,
      "value": "new"
    },
    {
      "id": 2,
      "value": "bundle"
    }
  ],
  "setup_fee": 500,
  "gifting_enabled": false,
  "pause_enabled": false,
  "pre_order_end_at": "2024-12-31",
  "funnel_id": 1,
  "change_product_collection_id": 1,
  "collect_shipping_address": true,
  "published": true,
  "items_count": 5,
  "plans_count": 2,
  "rulesets_count": 1,
  "metadata": [
    {
      "id": 1,
      "name": "Color",
      "slug": "color-red",
      "description": "description",
      "unit": "kg",
      "data_type": "single_line_string",
      "preset": true,
      "multiple": true,
      "variant": true,
      "access_level": "storefront",
      "save_behavior": "customer",
      "editable": true,
      "values": [
        {}
      ]
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Create a bundle plan

POST /bundles/{bundle_id}/plans

Path parameters

bundle_idRequiredinteger

Bundle ID

Request body

typeRequiredstring

A bundle may have at most one active one_time plan; creating a second one is rejected. There is no such limit on subscription plans.

Possible values: subscription, one_time.

nameRequiredstring

pricesoptionalobject[]

Required unless the bundle is configurable with no price_type; prohibited when the bundle is configurable and price_type is null. Must contain exactly one entry per active (non-archived) bundle ruleset. Quantities must be unique within a ruleset, the first entry's first range quantity must be 1, and every ruleset must repeat the same set of range quantities.

ruleset_idRequiredinteger

rangesRequiredobject[]

discountsoptionalobject[]

Only accepted when the bundle is configurable, has no price_type, and has a discount_type; prohibited otherwise. Must contain exactly one entry per active (non-archived) bundle ruleset, with unique quantities per ruleset, a first range quantity of 1, and the same set of range quantities across every ruleset.

ruleset_idRequiredinteger

rangesRequiredobject[]

frequency_unitoptionalstring

Required for subscription type. day is rejected when a rebilling day is set without an anchor_date (soft-anchored billing).

Possible values: day, week, month.

frequency_countoptionalinteger

Required for subscription type. Minimum is 1, but rises to 2 when rebilling_day is set together with frequency_unit day.

shippingsoptionalobject[]

Required for non-digital subscription bundles. Prohibited for digital bundles. Every entry must use the same shape: all buffered (add_unit/add_count) or all anchored (unit_day/unit_offset).

add_unitoptionalstring

Buffered shipping unit. Required when unit_day is absent; prohibited when any entry uses unit_day. Restricted by frequency_unit: day frequency allows only day, week frequency allows day and week, month frequency allows all three.

Possible values: day, week, month.

add_countoptionalinteger

Buffered shipping count. Required with add_unit; prohibited when any entry uses unit_day. Range depends on add_unit: -1 to the number of days in one billing cycle for day (-1 means same-day shipping), 0 to frequency_count (or frequency_count x 4 for non-weekly frequency) for week, 0 to frequency_count for month.

unit_dayoptionalinteger

Anchored shipping day. Required when add_unit is absent. Must be 1 to frequency_count for day frequency, 1-7 for week frequency, 1-31 for month frequency.

unit_offsetoptionalinteger

Anchored shipping offset. Required with unit_day. Must be between 0 and frequency_count - 1.

anchor_dateoptionalstring | null

Date in Y-m-d format; the literal 'today' is accepted and normalised. Only allowed when at least one shippings entry uses unit_day (anchored shipping), and required there when frequency_unit is day. Rejected when frequency_count is 1. For ad-hoc plans (no rebilling day set) it must be today. Otherwise it must fall between tomorrow and now plus frequency_count frequency_units.

Format: date.

rebilling_dayoptionalinteger | null

For daily frequency on non-digital bundles. Must be 1. Mutually exclusive with rebilling_day_of_month and rebilling_day_of_week.

Possible values: 1.

rebilling_day_of_monthoptionalinteger | null

For monthly frequency on non-digital bundles. Day of month (1-31). Mutually exclusive with rebilling_day and rebilling_day_of_week. When anchor_date is set it must equal that date's day of month.

rebilling_day_of_weekoptionalinteger | null

For weekly frequency on non-digital bundles. Day of week (1-7, Monday = 1). Mutually exclusive with rebilling_day and rebilling_day_of_month. When anchor_date is set it must equal that date's ISO day of week.

cut_off_daysoptionalinteger | null

Required when at least one shippings entry uses unit_day (anchored shipping), and prohibited otherwise. A non-zero value must not exceed the number of days in one billing cycle (frequency_unit x frequency_count).

cut_off_timeoptionalstring | null

Time in HH:MM (24h). Defaults to 23:59 when cut_off_days is sent without it. Rejected for digital bundles, for schedules that are not anchored (no unit_day), and when the shop's plan does not include the cut-off time feature.

charge_immediatelyoptionalinteger

Prohibited for digital bundles. Must be sent together with ship_immediately. For ad-hoc plans (no rebilling day set) only 1 is accepted.

Possible values: 0, 1.

ship_immediatelyoptionalinteger

Must be sent together with charge_immediately. Cannot be 1 while charge_immediately is 0.

Possible values: 0, 1.

buffer_daysoptionalinteger | null

Prohibited for digital bundles and rejected unless ship_immediately is 1. Maximum is frequency_count multiplied by 1 for day, 7 for week, or 31 for month frequency.

trial_priceoptionalinteger | null

Prohibited on pre-order bundles and on plans with a rebilling day set (non ad-hoc). Must be sent together with trial_length_days.

trial_length_daysoptionalinteger | null

Prohibited on pre-order bundles and on plans with a rebilling day set (non ad-hoc). Must be sent together with trial_price.

trial_single_orderoptionalinteger

Can only be 1 on non-digital bundles and only when trial_length_days is set.

Possible values: 0, 1.

commitment_billing_countoptionalinteger | null

Only accepted when the shop's plan includes commitment billing; otherwise rejected.

charges_limitoptionalinteger | null

survey_idoptionalinteger | null

ReturnsBundlePlan

Bundle plan created successfully. Only variant, prices and discounts are populated; pricing and plan are always null on this response, so fetch the plan with GET and expand[]=plan to retrieve them.

idinteger

pricingPlan | nullDeprecated

Expandable. Single pricing object (for subscription products). Deprecated - use 'plan' instead.

planPlan | null

Expandable. Single plan object (for subscription products)

variantVariant | null

Expandable. Single variant object (for one-time products)

pricingsPlan[] | nullDeprecated

Deprecated - always returns null

variantsVariant[] | nullDeprecated

Deprecated - always returns null

pricesBundlePrice[]

discountsBundleDiscount[]

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl -X POST https://api.subbly.co/private/v1/bundles/{bundle_id}/plans \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "subscription",
  "name": "name",
  "prices": [
    {
      "ruleset_id": 1,
      "ranges": [
        {
          "quantity": 1,
          "amount": 0
        }
      ]
    }
  ],
  "discounts": [
    {
      "ruleset_id": 1,
      "ranges": [
        {
          "quantity": 1,
          "amount_off": 0,
          "percent_off": 0
        }
      ]
    }
  ],
  "frequency_unit": "day",
  "frequency_count": 1,
  "shippings": [
    {
      "add_unit": "day",
      "add_count": 1,
      "unit_day": 1,
      "unit_offset": 1
    }
  ],
  "anchor_date": "2026-01-15",
  "rebilling_day": 1,
  "rebilling_day_of_month": 1,
  "rebilling_day_of_week": 1,
  "cut_off_days": 0,
  "cut_off_time": "cut_off_time",
  "charge_immediately": 0,
  "ship_immediately": 0,
  "buffer_days": 0,
  "trial_price": 0,
  "trial_length_days": 0,
  "trial_single_order": 0,
  "commitment_billing_count": 1,
  "charges_limit": 1,
  "survey_id": 1
}'

Response

{
  "id": 1,
  "pricing": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "pricing_name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "frequency_unit": "month",
    "frequency_count": 1,
    "anchored": true,
    "anchor_date": "2022-04-01",
    "rebilling_day": 1,
    "rebilling_day_of_week": 1,
    "rebilling_day_of_month": 1,
    "trial_price": null,
    "trial_length": null,
    "trial_single_order": true,
    "charge_immediately": true,
    "ship_immediately": true,
    "rebilling_start_at": "2022-04-01",
    "cut_off_at": "2022-04-01",
    "cut_off_time": "23:59",
    "cut_off_days": 0,
    "buffer_days": 0,
    "stock_count": 100,
    "setup_fee": null,
    "pre_order_end_at": "2022-04-01",
    "shippings": [
      {}
    ],
    "metadata": [
      {}
    ],
    "survey": {},
    "commitment_billing_count": 0,
    "charges_limit": 0,
    "plan_hash": "a1b2c3d4",
    "published": true,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "plan": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "pricing_name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "frequency_unit": "month",
    "frequency_count": 1,
    "anchored": true,
    "anchor_date": "2022-04-01",
    "rebilling_day": 1,
    "rebilling_day_of_week": 1,
    "rebilling_day_of_month": 1,
    "trial_price": null,
    "trial_length": null,
    "trial_single_order": true,
    "charge_immediately": true,
    "ship_immediately": true,
    "rebilling_start_at": "2022-04-01",
    "cut_off_at": "2022-04-01",
    "cut_off_time": "23:59",
    "cut_off_days": 0,
    "buffer_days": 0,
    "stock_count": 100,
    "setup_fee": null,
    "pre_order_end_at": "2022-04-01",
    "shippings": [
      {}
    ],
    "metadata": [
      {}
    ],
    "survey": {},
    "commitment_billing_count": 0,
    "charges_limit": 0,
    "plan_hash": "a1b2c3d4",
    "published": true,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "variant": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "pricings": [
    {
      "id": 1,
      "bundle_plan_id": 1,
      "bundle_plan": {},
      "name": "Yellow T-shirt with pokemon print",
      "pricing_name": "Yellow T-shirt with pokemon print",
      "description": "Yellow T-shirt with pokemon print",
      "price": 799,
      "price_schema": {},
      "price_scheme": {},
      "parent": {},
      "product": {},
      "frequency_unit": "month",
      "frequency_count": 1,
      "anchored": true,
      "anchor_date": "2022-04-01",
      "rebilling_day": 1,
      "rebilling_day_of_week": 1,
      "rebilling_day_of_month": 1,
      "trial_price": null,
      "trial_length": null,
      "trial_single_order": true,
      "charge_immediately": true,
      "ship_immediately": true,
      "rebilling_start_at": "2022-04-01",
      "cut_off_at": "2022-04-01",
      "cut_off_time": "23:59",
      "cut_off_days": 0,
      "buffer_days": 0,
      "stock_count": 100,
      "setup_fee": null,
      "pre_order_end_at": "2022-04-01",
      "shippings": [
        {}
      ],
      "metadata": [
        {}
      ],
      "survey": {},
      "commitment_billing_count": 0,
      "charges_limit": 0,
      "plan_hash": "a1b2c3d4",
      "published": true,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "variants": [
    {
      "id": 1,
      "bundle_plan_id": 1,
      "bundle_plan": {},
      "name": "Yellow T-shirt with pokemon print",
      "description": "Yellow T-shirt with pokemon print",
      "price": 799,
      "price_schema": {},
      "price_scheme": {},
      "parent": {},
      "product": {},
      "metadata": [
        {}
      ],
      "attributes": [
        {}
      ],
      "options": [
        {}
      ],
      "stock_count": 100,
      "published": true,
      "inventory_item_id": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Get bundle plan by ID

GET /bundles/{bundle_id}/plans/{plan_id}

Path parameters

bundle_idRequiredinteger

Bundle ID

plan_idRequiredinteger

Bundle plan ID

Query parameters

expand[]optionalstring[]

List of relations to expand in the response.

ReturnsBundlePlan

Bundle plan object response

idinteger

pricingPlan | nullDeprecated

Expandable. Single pricing object (for subscription products). Deprecated - use 'plan' instead.

planPlan | null

Expandable. Single plan object (for subscription products)

variantVariant | null

Expandable. Single variant object (for one-time products)

pricingsPlan[] | nullDeprecated

Deprecated - always returns null

variantsVariant[] | nullDeprecated

Deprecated - always returns null

pricesBundlePrice[]

discountsBundleDiscount[]

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl https://api.subbly.co/private/v1/bundles/{bundle_id}/plans/{plan_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "pricing": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "pricing_name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "frequency_unit": "month",
    "frequency_count": 1,
    "anchored": true,
    "anchor_date": "2022-04-01",
    "rebilling_day": 1,
    "rebilling_day_of_week": 1,
    "rebilling_day_of_month": 1,
    "trial_price": null,
    "trial_length": null,
    "trial_single_order": true,
    "charge_immediately": true,
    "ship_immediately": true,
    "rebilling_start_at": "2022-04-01",
    "cut_off_at": "2022-04-01",
    "cut_off_time": "23:59",
    "cut_off_days": 0,
    "buffer_days": 0,
    "stock_count": 100,
    "setup_fee": null,
    "pre_order_end_at": "2022-04-01",
    "shippings": [
      {}
    ],
    "metadata": [
      {}
    ],
    "survey": {},
    "commitment_billing_count": 0,
    "charges_limit": 0,
    "plan_hash": "a1b2c3d4",
    "published": true,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "plan": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "pricing_name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "frequency_unit": "month",
    "frequency_count": 1,
    "anchored": true,
    "anchor_date": "2022-04-01",
    "rebilling_day": 1,
    "rebilling_day_of_week": 1,
    "rebilling_day_of_month": 1,
    "trial_price": null,
    "trial_length": null,
    "trial_single_order": true,
    "charge_immediately": true,
    "ship_immediately": true,
    "rebilling_start_at": "2022-04-01",
    "cut_off_at": "2022-04-01",
    "cut_off_time": "23:59",
    "cut_off_days": 0,
    "buffer_days": 0,
    "stock_count": 100,
    "setup_fee": null,
    "pre_order_end_at": "2022-04-01",
    "shippings": [
      {}
    ],
    "metadata": [
      {}
    ],
    "survey": {},
    "commitment_billing_count": 0,
    "charges_limit": 0,
    "plan_hash": "a1b2c3d4",
    "published": true,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "variant": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "pricings": [
    {
      "id": 1,
      "bundle_plan_id": 1,
      "bundle_plan": {},
      "name": "Yellow T-shirt with pokemon print",
      "pricing_name": "Yellow T-shirt with pokemon print",
      "description": "Yellow T-shirt with pokemon print",
      "price": 799,
      "price_schema": {},
      "price_scheme": {},
      "parent": {},
      "product": {},
      "frequency_unit": "month",
      "frequency_count": 1,
      "anchored": true,
      "anchor_date": "2022-04-01",
      "rebilling_day": 1,
      "rebilling_day_of_week": 1,
      "rebilling_day_of_month": 1,
      "trial_price": null,
      "trial_length": null,
      "trial_single_order": true,
      "charge_immediately": true,
      "ship_immediately": true,
      "rebilling_start_at": "2022-04-01",
      "cut_off_at": "2022-04-01",
      "cut_off_time": "23:59",
      "cut_off_days": 0,
      "buffer_days": 0,
      "stock_count": 100,
      "setup_fee": null,
      "pre_order_end_at": "2022-04-01",
      "shippings": [
        {}
      ],
      "metadata": [
        {}
      ],
      "survey": {},
      "commitment_billing_count": 0,
      "charges_limit": 0,
      "plan_hash": "a1b2c3d4",
      "published": true,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "variants": [
    {
      "id": 1,
      "bundle_plan_id": 1,
      "bundle_plan": {},
      "name": "Yellow T-shirt with pokemon print",
      "description": "Yellow T-shirt with pokemon print",
      "price": 799,
      "price_schema": {},
      "price_scheme": {},
      "parent": {},
      "product": {},
      "metadata": [
        {}
      ],
      "attributes": [
        {}
      ],
      "options": [
        {}
      ],
      "stock_count": 100,
      "published": true,
      "inventory_item_id": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Update a bundle plan

PUT /bundles/{bundle_id}/plans/{plan_id}

Path parameters

bundle_idRequiredinteger

Bundle ID

plan_idRequiredinteger

Bundle plan ID

Request body

nameoptionalstring

pricesoptionalobject[]

Cannot be changed while the plan has active subscriptions. Prohibited when the bundle is configurable with no price_type. When sent, must contain exactly one entry per active bundle ruleset, with a first range quantity of 1 and the same set of range quantities across every ruleset.

ruleset_idRequiredinteger

rangesRequiredobject[]

discountsoptionalobject[]

Cannot be changed while the plan has active subscriptions. Only accepted when the bundle is configurable, has no price_type, and has a discount_type. Same per-ruleset range structure as prices.

ruleset_idRequiredinteger

rangesRequiredobject[]

shippingsoptionalobject[]

Prohibited for digital bundles. Every entry must use the same shape: all buffered (add_unit/add_count) or all anchored (unit_day/unit_offset). Bounds are validated against the plan's existing frequency_unit and frequency_count, which this endpoint cannot change.

add_unitoptionalstring

Possible values: day, week, month.

add_countoptionalinteger

unit_dayoptionalinteger

Anchored shipping day. Required when add_unit is absent. Must be 1 to frequency_count for day frequency, 1-7 for week frequency, 1-31 for month frequency.

unit_offsetoptionalinteger

Anchored shipping offset. Required with unit_day. Must be between 0 and frequency_count - 1.

cut_off_daysoptionalinteger | null

Required when the plan's shipping schedule is anchored (unit_day), prohibited otherwise. The anchored state comes from the shippings payload when sent, and from the stored schedule when it is not.

cut_off_timeoptionalstring | null

Time in HH:MM (24h). Defaults to 23:59 when cut_off_days is sent without it. Rejected for digital bundles, for non-anchored schedules, and when the shop's plan does not include the cut-off time feature.

charge_immediatelyoptionalinteger

Prohibited for digital bundles. Must be sent together with ship_immediately. Must be 1 when the stored plan has no rebilling day (ad-hoc billing).

Possible values: 0, 1.

ship_immediatelyoptionalinteger

Must be sent together with charge_immediately and cannot be 1 while charge_immediately is 0. Cannot be set to 0 while buffer_days is still set, so clear buffer_days in the same request.

Possible values: 0, 1.

buffer_daysoptionalinteger | null

Only accepted when the plan has exactly one shipment schedule entry, and only while ship_immediately is 1. Maximum is frequency_count multiplied by 1 for day, 7 for week, or 31 for month frequency.

trial_priceoptionalinteger | null

Prohibited on pre-order bundles and on plans with a rebilling day set. trial_price and trial_length_days must be sent together.

trial_length_daysoptionalinteger | null

Prohibited on pre-order bundles and on plans with a rebilling day set. trial_price and trial_length_days must be sent together.

trial_single_orderoptionalinteger

Can only be 1 on non-digital bundles and only when the plan has a trial length.

Possible values: 0, 1.

commitment_billing_countoptionalinteger | null

Only accepted when the shop's plan includes commitment billing.

charges_limitoptionalinteger | null

survey_idoptionalinteger | null

ReturnsBundlePlan

Bundle plan object response. Only variant, prices and discounts are populated; pricing and plan are always null on this response, so fetch the plan with GET and expand[]=plan to retrieve them.

idinteger

pricingPlan | nullDeprecated

Expandable. Single pricing object (for subscription products). Deprecated - use 'plan' instead.

planPlan | null

Expandable. Single plan object (for subscription products)

variantVariant | null

Expandable. Single variant object (for one-time products)

pricingsPlan[] | nullDeprecated

Deprecated - always returns null

variantsVariant[] | nullDeprecated

Deprecated - always returns null

pricesBundlePrice[]

discountsBundleDiscount[]

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl -X PUT https://api.subbly.co/private/v1/bundles/{bundle_id}/plans/{plan_id} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "name",
  "prices": [
    {
      "ruleset_id": 1,
      "ranges": [
        {
          "quantity": 1,
          "amount": 0
        }
      ]
    }
  ],
  "discounts": [
    {
      "ruleset_id": 1,
      "ranges": [
        {
          "quantity": 1,
          "amount_off": 0,
          "percent_off": 0
        }
      ]
    }
  ],
  "shippings": [
    {
      "add_unit": "day",
      "add_count": 1,
      "unit_day": 1,
      "unit_offset": 1
    }
  ],
  "cut_off_days": 0,
  "cut_off_time": "cut_off_time",
  "charge_immediately": 0,
  "ship_immediately": 0,
  "buffer_days": 0,
  "trial_price": 0,
  "trial_length_days": 0,
  "trial_single_order": 0,
  "commitment_billing_count": 1,
  "charges_limit": 1,
  "survey_id": 1
}'

Response

{
  "id": 1,
  "pricing": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "pricing_name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "frequency_unit": "month",
    "frequency_count": 1,
    "anchored": true,
    "anchor_date": "2022-04-01",
    "rebilling_day": 1,
    "rebilling_day_of_week": 1,
    "rebilling_day_of_month": 1,
    "trial_price": null,
    "trial_length": null,
    "trial_single_order": true,
    "charge_immediately": true,
    "ship_immediately": true,
    "rebilling_start_at": "2022-04-01",
    "cut_off_at": "2022-04-01",
    "cut_off_time": "23:59",
    "cut_off_days": 0,
    "buffer_days": 0,
    "stock_count": 100,
    "setup_fee": null,
    "pre_order_end_at": "2022-04-01",
    "shippings": [
      {}
    ],
    "metadata": [
      {}
    ],
    "survey": {},
    "commitment_billing_count": 0,
    "charges_limit": 0,
    "plan_hash": "a1b2c3d4",
    "published": true,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "plan": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "pricing_name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "frequency_unit": "month",
    "frequency_count": 1,
    "anchored": true,
    "anchor_date": "2022-04-01",
    "rebilling_day": 1,
    "rebilling_day_of_week": 1,
    "rebilling_day_of_month": 1,
    "trial_price": null,
    "trial_length": null,
    "trial_single_order": true,
    "charge_immediately": true,
    "ship_immediately": true,
    "rebilling_start_at": "2022-04-01",
    "cut_off_at": "2022-04-01",
    "cut_off_time": "23:59",
    "cut_off_days": 0,
    "buffer_days": 0,
    "stock_count": 100,
    "setup_fee": null,
    "pre_order_end_at": "2022-04-01",
    "shippings": [
      {}
    ],
    "metadata": [
      {}
    ],
    "survey": {},
    "commitment_billing_count": 0,
    "charges_limit": 0,
    "plan_hash": "a1b2c3d4",
    "published": true,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "variant": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "pricings": [
    {
      "id": 1,
      "bundle_plan_id": 1,
      "bundle_plan": {},
      "name": "Yellow T-shirt with pokemon print",
      "pricing_name": "Yellow T-shirt with pokemon print",
      "description": "Yellow T-shirt with pokemon print",
      "price": 799,
      "price_schema": {},
      "price_scheme": {},
      "parent": {},
      "product": {},
      "frequency_unit": "month",
      "frequency_count": 1,
      "anchored": true,
      "anchor_date": "2022-04-01",
      "rebilling_day": 1,
      "rebilling_day_of_week": 1,
      "rebilling_day_of_month": 1,
      "trial_price": null,
      "trial_length": null,
      "trial_single_order": true,
      "charge_immediately": true,
      "ship_immediately": true,
      "rebilling_start_at": "2022-04-01",
      "cut_off_at": "2022-04-01",
      "cut_off_time": "23:59",
      "cut_off_days": 0,
      "buffer_days": 0,
      "stock_count": 100,
      "setup_fee": null,
      "pre_order_end_at": "2022-04-01",
      "shippings": [
        {}
      ],
      "metadata": [
        {}
      ],
      "survey": {},
      "commitment_billing_count": 0,
      "charges_limit": 0,
      "plan_hash": "a1b2c3d4",
      "published": true,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "variants": [
    {
      "id": 1,
      "bundle_plan_id": 1,
      "bundle_plan": {},
      "name": "Yellow T-shirt with pokemon print",
      "description": "Yellow T-shirt with pokemon print",
      "price": 799,
      "price_schema": {},
      "price_scheme": {},
      "parent": {},
      "product": {},
      "metadata": [
        {}
      ],
      "attributes": [
        {}
      ],
      "options": [
        {}
      ],
      "stock_count": 100,
      "published": true,
      "inventory_item_id": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Archive a bundle plan

POST /bundles/{bundle_id}/plans/{plan_id}/archive

Archives a bundle plan. Rejected with 400 when the plan is already archived, when it is the bundle's last non-archived plan (error code last_active_plan), or when it still has active subscriptions (error code bundle_plan_has_active_subscriptions).

Path parameters

bundle_idRequiredinteger

Bundle ID

plan_idRequiredinteger

Bundle plan ID

ReturnsBundlePlan

Bundle plan object response. No relations are expanded on this response, so pricing, plan and variant are always null, and prices and discounts are always empty arrays.

idinteger

pricingPlan | nullDeprecated

Expandable. Single pricing object (for subscription products). Deprecated - use 'plan' instead.

planPlan | null

Expandable. Single plan object (for subscription products)

variantVariant | null

Expandable. Single variant object (for one-time products)

pricingsPlan[] | nullDeprecated

Deprecated - always returns null

variantsVariant[] | nullDeprecated

Deprecated - always returns null

pricesBundlePrice[]

discountsBundleDiscount[]

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl -X POST https://api.subbly.co/private/v1/bundles/{bundle_id}/plans/{plan_id}/archive \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "pricing": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "pricing_name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "frequency_unit": "month",
    "frequency_count": 1,
    "anchored": true,
    "anchor_date": "2022-04-01",
    "rebilling_day": 1,
    "rebilling_day_of_week": 1,
    "rebilling_day_of_month": 1,
    "trial_price": null,
    "trial_length": null,
    "trial_single_order": true,
    "charge_immediately": true,
    "ship_immediately": true,
    "rebilling_start_at": "2022-04-01",
    "cut_off_at": "2022-04-01",
    "cut_off_time": "23:59",
    "cut_off_days": 0,
    "buffer_days": 0,
    "stock_count": 100,
    "setup_fee": null,
    "pre_order_end_at": "2022-04-01",
    "shippings": [
      {}
    ],
    "metadata": [
      {}
    ],
    "survey": {},
    "commitment_billing_count": 0,
    "charges_limit": 0,
    "plan_hash": "a1b2c3d4",
    "published": true,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "plan": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "pricing_name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "frequency_unit": "month",
    "frequency_count": 1,
    "anchored": true,
    "anchor_date": "2022-04-01",
    "rebilling_day": 1,
    "rebilling_day_of_week": 1,
    "rebilling_day_of_month": 1,
    "trial_price": null,
    "trial_length": null,
    "trial_single_order": true,
    "charge_immediately": true,
    "ship_immediately": true,
    "rebilling_start_at": "2022-04-01",
    "cut_off_at": "2022-04-01",
    "cut_off_time": "23:59",
    "cut_off_days": 0,
    "buffer_days": 0,
    "stock_count": 100,
    "setup_fee": null,
    "pre_order_end_at": "2022-04-01",
    "shippings": [
      {}
    ],
    "metadata": [
      {}
    ],
    "survey": {},
    "commitment_billing_count": 0,
    "charges_limit": 0,
    "plan_hash": "a1b2c3d4",
    "published": true,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "variant": {
    "id": 1,
    "bundle_plan_id": 1,
    "bundle_plan": {},
    "name": "Yellow T-shirt with pokemon print",
    "description": "Yellow T-shirt with pokemon print",
    "price": 799,
    "price_schema": {},
    "price_scheme": {},
    "parent": {},
    "product": {},
    "metadata": [
      {}
    ],
    "attributes": [
      {}
    ],
    "options": [
      {}
    ],
    "stock_count": 100,
    "published": true,
    "inventory_item_id": 1,
    "created_at": "2022-04-01 00:00:00",
    "updated_at": "2022-04-01 00:00:00"
  },
  "pricings": [
    {
      "id": 1,
      "bundle_plan_id": 1,
      "bundle_plan": {},
      "name": "Yellow T-shirt with pokemon print",
      "pricing_name": "Yellow T-shirt with pokemon print",
      "description": "Yellow T-shirt with pokemon print",
      "price": 799,
      "price_schema": {},
      "price_scheme": {},
      "parent": {},
      "product": {},
      "frequency_unit": "month",
      "frequency_count": 1,
      "anchored": true,
      "anchor_date": "2022-04-01",
      "rebilling_day": 1,
      "rebilling_day_of_week": 1,
      "rebilling_day_of_month": 1,
      "trial_price": null,
      "trial_length": null,
      "trial_single_order": true,
      "charge_immediately": true,
      "ship_immediately": true,
      "rebilling_start_at": "2022-04-01",
      "cut_off_at": "2022-04-01",
      "cut_off_time": "23:59",
      "cut_off_days": 0,
      "buffer_days": 0,
      "stock_count": 100,
      "setup_fee": null,
      "pre_order_end_at": "2022-04-01",
      "shippings": [
        {}
      ],
      "metadata": [
        {}
      ],
      "survey": {},
      "commitment_billing_count": 0,
      "charges_limit": 0,
      "plan_hash": "a1b2c3d4",
      "published": true,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "variants": [
    {
      "id": 1,
      "bundle_plan_id": 1,
      "bundle_plan": {},
      "name": "Yellow T-shirt with pokemon print",
      "description": "Yellow T-shirt with pokemon print",
      "price": 799,
      "price_schema": {},
      "price_scheme": {},
      "parent": {},
      "product": {},
      "metadata": [
        {}
      ],
      "attributes": [
        {}
      ],
      "options": [
        {}
      ],
      "stock_count": 100,
      "published": true,
      "inventory_item_id": 1,
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "prices": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "discounts": [
    {
      "id": 1,
      "ruleset_id": 1,
      "plan_id": 1,
      "ranges": [
        {}
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}