Skip to main content
GET
Get a membership plan group

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