Skip to main content
GET
/
api
/
external
/
v2
/
subscription-groups
/
{subscriptionGroupId}
Get a membership plan group
curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-groups/{subscriptionGroupId}
import requests

url = "https://membership-admin.appstle.com/api/external/v2/subscription-groups/{subscriptionGroupId}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-groups/{subscriptionGroupId}', 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-groups/{subscriptionGroupId}';
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-groups/{subscriptionGroupId}",
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-groups/{subscriptionGroupId}"

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-groups/{subscriptionGroupId}")

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
{
  "accessoryProductIds": "<string>",
  "customerTag": "coffee-member",
  "formFieldsJson": "<string>",
  "groupName": "Premium Coffee Membership",
  "id": 456789,
  "memberOrderTag": "member-premium",
  "orderTag": "membership-order",
  "productCount": 123,
  "productId": "<string>",
  "productIds": "<string>",
  "productVariantCount": 123,
  "rulesJson": "<string>",
  "subscriptionPlans": [
    {
      "afterCycle1": 123,
      "afterCycle2": 123,
      "allowedForUpgradeDowngrade": true,
      "billingFrequencyCount": 123,
      "cutOff": 123,
      "discountEnabled": true,
      "discountEnabled2": true,
      "discountEnabled2Masked": true,
      "discountEnabledMasked": true,
      "discountOffer": 123,
      "discountOffer2": 123,
      "freeTrialCount": 123,
      "freeTrialEnabled": true,
      "frequencyCount": 123,
      "frequencyDescription": "<string>",
      "frequencyName": "<string>",
      "groupId": 123,
      "groupName": "<string>",
      "id": "<string>",
      "idNew": "<string>",
      "keepOriginalNextBillingDateAfterTrial": true,
      "lifeTimeMembership": true,
      "maxCycles": 123,
      "memberExclusiveTags": "<string>",
      "memberInclusiveTags": "<string>",
      "memberOnly": true,
      "minCycles": 123,
      "nonMemberOnly": true,
      "planSequence": 123,
      "prepaidFlag": "<string>",
      "rulesJson": "<string>",
      "specificDayEnabled": true,
      "specificDayValue": 123,
      "specificMonthValue": 123
    }
  ],
  "translations": "<string>",
  "variantIds": "<string>"
}

Headers

X-API-Key
string

Path Parameters

subscriptionGroupId
integer<int64>
required

Response

200 - */*

OK

accessoryProductIds
string
customerTag
string

Tag applied to customers when they subscribe to this plan

Example:

"coffee-member"

formFieldsJson
string
groupName
string

Display name of the membership plan group

Example:

"Premium Coffee Membership"

id
integer<int64>

Unique identifier of the membership plan group

Example:

456789

memberOrderTag
string

Tag applied to member renewal orders

Example:

"member-premium"

orderTag
string

Tag applied to subscription orders from this plan

Example:

"membership-order"

productCount
integer<int64>

Number of products assigned to this plan group

productId
string
productIds
string

Comma-separated Shopify product IDs assigned to this plan group

productVariantCount
integer<int64>

Number of product variants assigned to this plan group

rulesJson
string
subscriptionPlans
object[]

List of subscription plan frequencies within this group

translations
string
variantIds
string

Comma-separated Shopify variant IDs assigned to this plan group