Bundle Settings

Get bundle settings

Retrieves the subscription bundle configuration settings for the authenticated shop. Returns settings that control bundle behavior, pricing, and display options.

Key Features:

Bundle display preferences
Pricing calculation rules
Bundle discount configurations
Widget behavior settings

Use Cases:

Configure bundle widget behavior
Set bundle pricing rules
Customize bundle display options
Retrieve bundle configuration for frontend

Note: The ID parameter is provided for compatibility but settings are retrieved by authenticated shop.

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

GET

api

external

subscription-bundle-settings

{id}

Get bundle settings

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}

const options = {method: 'GET'};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "addButtonText": "<string>",
  "myDeliveryText": "<string>",
  "proceedToCheckoutButtonText": "<string>",
  "productsToProceedText": "<string>",
  "selectMinimumProductButtonText": "<string>",
  "selectedFrequencyLabelText": "<string>",
  "shop": "<string>",
  "backgroundColor": "<string>",
  "bundleBottomHtml": "<string>",
  "bundleRedirect": "CART",
  "bundleTopHtml": "<string>",
  "buttonBackgroundColor": "<string>",
  "buttonColor": "<string>",
  "currencySwitcherClassName": "<string>",
  "descriptionLength": 123,
  "failedToAddMsgText": "<string>",
  "failedToAddTitleText": "<string>",
  "id": 123,
  "isBundleWithoutScroll": true,
  "okBtnText": "<string>",
  "pageBackgroundColor": "<string>",
  "productPriceFormatField": "<string>",
  "productTitleFontColor": "<string>",
  "variantNotAvailable": "<string>"
}

{
  "addButtonText": "<string>",
  "myDeliveryText": "<string>",
  "proceedToCheckoutButtonText": "<string>",
  "productsToProceedText": "<string>",
  "selectMinimumProductButtonText": "<string>",
  "selectedFrequencyLabelText": "<string>",
  "shop": "<string>",
  "backgroundColor": "<string>",
  "bundleBottomHtml": "<string>",
  "bundleRedirect": "CART",
  "bundleTopHtml": "<string>",
  "buttonBackgroundColor": "<string>",
  "buttonColor": "<string>",
  "currencySwitcherClassName": "<string>",
  "descriptionLength": 123,
  "failedToAddMsgText": "<string>",
  "failedToAddTitleText": "<string>",
  "id": 123,
  "isBundleWithoutScroll": true,
  "okBtnText": "<string>",
  "pageBackgroundColor": "<string>",
  "productPriceFormatField": "<string>",
  "productTitleFontColor": "<string>",
  "variantNotAvailable": "<string>"
}

{
  "addButtonText": "<string>",
  "myDeliveryText": "<string>",
  "proceedToCheckoutButtonText": "<string>",
  "productsToProceedText": "<string>",
  "selectMinimumProductButtonText": "<string>",
  "selectedFrequencyLabelText": "<string>",
  "shop": "<string>",
  "backgroundColor": "<string>",
  "bundleBottomHtml": "<string>",
  "bundleRedirect": "CART",
  "bundleTopHtml": "<string>",
  "buttonBackgroundColor": "<string>",
  "buttonColor": "<string>",
  "currencySwitcherClassName": "<string>",
  "descriptionLength": 123,
  "failedToAddMsgText": "<string>",
  "failedToAddTitleText": "<string>",
  "id": 123,
  "isBundleWithoutScroll": true,
  "okBtnText": "<string>",
  "pageBackgroundColor": "<string>",
  "productPriceFormatField": "<string>",
  "productTitleFontColor": "<string>",
  "variantNotAvailable": "<string>"
}

Headers

X-API-Key

string

Path Parameters

integer<int64>

required

Settings ID (deprecated - retrieves by shop)

Query Parameters

api_key

string

API Key (Deprecated - Use Header X-API-Key instead)

Response

Bundle settings retrieved successfully

addButtonText

string

required

myDeliveryText

string

required

proceedToCheckoutButtonText

string

required

productsToProceedText

string

required

selectMinimumProductButtonText

string

required

selectedFrequencyLabelText

string

required

shop

string

required

backgroundColor

string

bundleBottomHtml

string

bundleRedirect

enum<string>

Available options:

CART,

CHECKOUT

bundleTopHtml

string

buttonBackgroundColor

string

buttonColor

string

currencySwitcherClassName

string

descriptionLength

integer<int32>

failedToAddMsgText

string

failedToAddTitleText

string

integer<int64>

isBundleWithoutScroll

boolean

okBtnText

string

pageBackgroundColor

string

productPriceFormatField

string

productTitleFontColor

string

variantNotAvailable

string

Get bundle settings

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}

const options = {method: 'GET'};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://membership-admin.appstle.com/api/external/v2/subscription-bundle-settings/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "addButtonText": "<string>",
  "myDeliveryText": "<string>",
  "proceedToCheckoutButtonText": "<string>",
  "productsToProceedText": "<string>",
  "selectMinimumProductButtonText": "<string>",
  "selectedFrequencyLabelText": "<string>",
  "shop": "<string>",
  "backgroundColor": "<string>",
  "bundleBottomHtml": "<string>",
  "bundleRedirect": "CART",
  "bundleTopHtml": "<string>",
  "buttonBackgroundColor": "<string>",
  "buttonColor": "<string>",
  "currencySwitcherClassName": "<string>",
  "descriptionLength": 123,
  "failedToAddMsgText": "<string>",
  "failedToAddTitleText": "<string>",
  "id": 123,
  "isBundleWithoutScroll": true,
  "okBtnText": "<string>",
  "pageBackgroundColor": "<string>",
  "productPriceFormatField": "<string>",
  "productTitleFontColor": "<string>",
  "variantNotAvailable": "<string>"
}

{
  "addButtonText": "<string>",
  "myDeliveryText": "<string>",
  "proceedToCheckoutButtonText": "<string>",
  "productsToProceedText": "<string>",
  "selectMinimumProductButtonText": "<string>",
  "selectedFrequencyLabelText": "<string>",
  "shop": "<string>",
  "backgroundColor": "<string>",
  "bundleBottomHtml": "<string>",
  "bundleRedirect": "CART",
  "bundleTopHtml": "<string>",
  "buttonBackgroundColor": "<string>",
  "buttonColor": "<string>",
  "currencySwitcherClassName": "<string>",
  "descriptionLength": 123,
  "failedToAddMsgText": "<string>",
  "failedToAddTitleText": "<string>",
  "id": 123,
  "isBundleWithoutScroll": true,
  "okBtnText": "<string>",
  "pageBackgroundColor": "<string>",
  "productPriceFormatField": "<string>",
  "productTitleFontColor": "<string>",
  "variantNotAvailable": "<string>"
}

{
  "addButtonText": "<string>",
  "myDeliveryText": "<string>",
  "proceedToCheckoutButtonText": "<string>",
  "productsToProceedText": "<string>",
  "selectMinimumProductButtonText": "<string>",
  "selectedFrequencyLabelText": "<string>",
  "shop": "<string>",
  "backgroundColor": "<string>",
  "bundleBottomHtml": "<string>",
  "bundleRedirect": "CART",
  "bundleTopHtml": "<string>",
  "buttonBackgroundColor": "<string>",
  "buttonColor": "<string>",
  "currencySwitcherClassName": "<string>",
  "descriptionLength": 123,
  "failedToAddMsgText": "<string>",
  "failedToAddTitleText": "<string>",
  "id": 123,
  "isBundleWithoutScroll": true,
  "okBtnText": "<string>",
  "pageBackgroundColor": "<string>",
  "productPriceFormatField": "<string>",
  "productTitleFontColor": "<string>",
  "variantNotAvailable": "<string>"
}

Get Started

Guides

Partner Integration

Webhooks

Admin API

Customer Portal API

Get bundle settings

Headers

Path Parameters

Query Parameters

Response