> ## Documentation Index
> Fetch the complete documentation index at: https://developers.appstle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a membership plan group

> Retrieves a specific membership/subscription plan group by its Shopify selling plan group ID, including all plan configurations and assigned products.



## OpenAPI

````yaml /memberships/admin-api-swagger.json get /api/external/v2/subscription-groups/{subscriptionGroupId}
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for managing memberships, payments, and
    related operations. These APIs allow you to programmatically manage
    membership lifecycles, handle payments, configure products, and integrate
    membership functionality into your applications.
  title: Admin APIs
  version: 0.0.1
servers:
  - url: https://membership-admin.appstle.com
security: []
tags:
  - description: >-
      APIs for managing Shopify delivery profiles, shipping rates, zones, and
      free shipping configuration for subscription memberships
    name: Shipping & Delivery Profiles
  - description: >-
      APIs for retrieving historical discount code usage and redemption
      information for membership contracts
    name: Customer Discount History
  - description: >-
      APIs for managing membership cancellation flow settings including
      retention offers, survey questions, and cancel confirmation screens
    name: Cancellation Flow Configuration
  - description: >-
      APIs for managing membership billing attempts, recurring orders, payment
      retries, order history, and order skipping
    name: Billing & Orders
  - description: >-
      APIs for managing one-time product additions to upcoming subscription
      orders, including adding, retrieving, and removing one-off items
    name: One-Time Add-Ons
  - description: >-
      APIs for managing membership/subscription plan groups, including creating
      plans, configuring discounts, billing intervals, and assigning products to
      plans
    name: Membership Plans
  - description: >-
      APIs for managing subscription product bundles, bundle configurations,
      item grouping, and bundle-specific discount codes
    name: Product Bundles
  - description: >-
      APIs for retrieving custom CSS styles applied to subscription widgets and
      customer portal for theme customization
    name: Custom CSS Styling
  - description: >-
      APIs for managing customer portal settings including UI customization,
      text labels, feature toggles, and branding options for the member
      self-service portal
    name: Customer Portal Configuration
  - description: >-
      APIs for managing membership/subscription contracts including creation,
      updates, status changes, line items, discounts, and billing operations
    name: Membership Contracts
  - description: >-
      APIs for managing subscription bundle configuration settings including
      bundle behavior, pricing rules, and display options
    name: Bundle Settings
  - description: >-
      APIs for managing customer payment methods, payment tokens, and payment
      method retrieval for subscriptions
    name: Customer Payment Methods
  - description: >-
      APIs for retrieving product swap/substitution options allowing members to
      exchange subscription items based on configured swap rules and variant
      groups
    name: Product Swap Rules
  - description: >-
      APIs for retrieving product catalog, variants, pricing, and inventory
      information for subscription memberships.
    name: Product & Inventory Data
  - description: >-
      APIs for managing shop-level membership settings, configuration, and
      general store information.
    name: Shop Settings
  - description: >-
      APIs for performing bulk/mass operations on multiple membership contracts
      including status updates, product replacements, and billing date changes.
    name: Bulk Operations
paths:
  /api/external/v2/subscription-groups/{subscriptionGroupId}:
    get:
      tags:
        - Membership Plans
      summary: Get a membership plan group
      description: >-
        Retrieves a specific membership/subscription plan group by its Shopify
        selling plan group ID, including all plan configurations and assigned
        products.
      operationId: getSubscriptionGroupV2
      parameters:
        - in: path
          name: subscriptionGroupId
          required: true
          schema:
            format: int64
            type: integer
        - in: header
          name: X-API-Key
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SubscriptionGroupV2DTO'
          description: OK
components:
  schemas:
    SubscriptionGroupV2DTO:
      properties:
        accessoryProductIds:
          type: string
        customerTag:
          description: Tag applied to customers when they subscribe to this plan
          example: coffee-member
          type: string
        formFieldsJson:
          type: string
        groupName:
          description: Display name of the membership plan group
          example: Premium Coffee Membership
          type: string
        id:
          description: Unique identifier of the membership plan group
          example: 456789
          format: int64
          type: integer
        memberOrderTag:
          description: Tag applied to member renewal orders
          example: member-premium
          type: string
        orderTag:
          description: Tag applied to subscription orders from this plan
          example: membership-order
          type: string
        productCount:
          description: Number of products assigned to this plan group
          format: int64
          type: integer
        productId:
          type: string
        productIds:
          description: Comma-separated Shopify product IDs assigned to this plan group
          type: string
        productVariantCount:
          description: Number of product variants assigned to this plan group
          format: int64
          type: integer
        rulesJson:
          type: string
        subscriptionPlans:
          description: List of subscription plan frequencies within this group
          items:
            $ref: '#/components/schemas/FrequencyInfoDTO'
          type: array
        translations:
          type: string
        variantIds:
          description: Comma-separated Shopify variant IDs assigned to this plan group
          type: string
      type: object
    FrequencyInfoDTO:
      properties:
        afterCycle1:
          format: int32
          type: integer
        afterCycle2:
          format: int32
          type: integer
        allowedForUpgradeDowngrade:
          type: boolean
        billingFrequencyCount:
          format: int32
          type: integer
        billingFrequencyInterval:
          enum:
            - DAY
            - WEEK
            - MONTH
            - YEAR
          type: string
        cutOff:
          format: int32
          type: integer
        deliveryPolicyPreAnchorBehavior:
          enum:
            - ASAP
            - NEXT
            - $UNKNOWN
          type: string
        discountEnabled:
          type: boolean
        discountEnabled2:
          type: boolean
        discountEnabled2Masked:
          type: boolean
        discountEnabledMasked:
          type: boolean
        discountOffer:
          format: double
          type: number
        discountOffer2:
          format: double
          type: number
        discountType:
          enum:
            - PERCENTAGE
            - FIXED
            - PRICE
          type: string
        discountType2:
          enum:
            - PERCENTAGE
            - FIXED
            - PRICE
          type: string
        freeTrialCount:
          format: int32
          type: integer
        freeTrialEnabled:
          type: boolean
        freeTrialInterval:
          enum:
            - DAY
            - WEEK
            - MONTH
            - YEAR
          type: string
        frequencyCount:
          format: int32
          type: integer
        frequencyDescription:
          type: string
        frequencyInterval:
          enum:
            - DAY
            - WEEK
            - MONTH
            - YEAR
          type: string
        frequencyName:
          type: string
        frequencyType:
          enum:
            - ON_PURCHASE_DAY
            - ON_SPECIFIC_DAY
          type: string
        groupId:
          format: int64
          type: integer
        groupName:
          type: string
        id:
          type: string
        idNew:
          type: string
        keepOriginalNextBillingDateAfterTrial:
          type: boolean
        lifeTimeMembership:
          type: boolean
        maxCycles:
          format: int32
          type: integer
        memberExclusiveTags:
          type: string
        memberInclusiveTags:
          type: string
        memberOnly:
          type: boolean
        minCycles:
          format: int32
          type: integer
        nonMemberOnly:
          type: boolean
        planSequence:
          format: int32
          type: integer
        planType:
          enum:
            - PAY_AS_YOU_GO
            - PREPAID
            - ADVANCED_PREPAID
          type: string
        prepaidFlag:
          type: string
        rulesJson:
          type: string
        specificDayEnabled:
          type: boolean
        specificDayValue:
          format: int32
          type: integer
        specificMonthValue:
          format: int32
          type: integer
      type: object

````