Create a new subscription group (selling plan group)
Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules.
Key Features:
Create multiple subscription plans within a single group
Add all products from the store or collection to this subscription group. When true without collectionId: adds all active products in the store. When true with collectionId: adds all products from the specified collection. This operation runs asynchronously and may take time for large catalogs.
Shopify collection ID to limit product addition when isAddAllProduct is true. Format: numeric ID without gid prefix (e.g., '123456789' not 'gid://shopify/Collection/123456789')
Body
application/json
Complete subscription group configuration including name, plans, and product assignments
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Appstle","colors":{"primary":"#0caceb","light":"#6ccdf2","dark":"#0a7eae"},"favicon":"https://mintcdn.com/appstleinc-aeca3e0a/811jRr2WFwD6kXFw/favicon.webp?fit=max\u0026auto=format\u0026n=811jRr2WFwD6kXFw\u0026q=85\u0026s=a98f329ae5c5ff4deaa241d8abe53f11","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","python","javascript","node","php","go","ruby"]}},"appearance":{"default":"light","strict":true},"navbar":{"primary":{"type":"button","label":"Help Center","href":"https://help.appstle.com/en/"}},"footer":{"socials":{"website":"https://appstle.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"appstleinc-aeca3e0a","hasAudioNarration":false,"actualSubdomain":"appstleinc-aeca3e0a","customDomains":["developers.appstle.com"],"gitSource":{"type":"github","owner":"appstleinc","repo":"appstle-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af345c7fba0656120fa46f2","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Subscriptions","count":268},{"language":"default","tag":"Storefront API","count":223},{"language":"default","tag":"Admin API","count":184},{"language":"default","tag":"Memberships","count":119},{"language":"default","tag":"Subscription Contracts","count":63},{"language":"default","tag":"Membership Contracts","count":62},{"language":"default","tag":"Loyalty","count":48},{"language":"default","tag":"Billing \u0026 Payments","count":28},{"language":"default","tag":"Bundles","count":25},{"language":"default","tag":"Subscription Management","count":24}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group","slug":"/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group","pageMetadata":{"title":"Create a new subscription group (selling plan group)","description":"Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules.\n\n**Key Features:**\n- Create multiple subscription plans within a single group\n- Configure complex discount tiers (up to 2 levels + custom cycles)\n- Set up free trials with automatic discount transitions\n- Define prepaid plans (PAY_AS_YOU_GO_PREPAID) with custom billing cycles\n- Configure member-only plans with tag-based access control\n- Set specific delivery dates (e.g., 15th of every month)\n- Add all products from store or specific collection automatically\n\n**Discount Configuration:**\n- First discount tier: Applied from a specific cycle (afterCycle1)\n- Second discount tier: Applied from another cycle (afterCycle2)\n- Additional cycles: Configure via appstleCycles for complex scenarios\n- Free trials: Automatically configure 100% discount for trial period\n\n**Product Assignment:**\n- Assign specific products via productIds field in request body\n- Assign specific variants via variantIds field in request body\n- Use isAddAllProduct=true to add all store products\n- Use collectionId with isAddAllProduct=true to add all products from a collection\n\n**Authentication:** Requires valid X-API-Key header","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-groups","href":"/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Key Features:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Create multiple subscription plans within a single group\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Configure complex discount tiers (up to 2 levels + custom cycles)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Set up free trials with automatic discount transitions\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Define prepaid plans (PAY_AS_YOU_GO_PREPAID) with custom billing cycles\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Configure member-only plans with tag-based access control\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Set specific delivery dates (e.g., 15th of every month)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Add all products from store or specific collection automatically\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Discount Configuration:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"First discount tier: Applied from a specific cycle (afterCycle1)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Second discount tier: Applied from another cycle (afterCycle2)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Additional cycles: Configure via appstleCycles for complex scenarios\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Free trials: Automatically configure 100% discount for trial period\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Product Assignment:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Assign specific products via productIds field in request body\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Assign specific variants via variantIds field in request body\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Use isAddAllProduct=true to add all store products\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Use collectionId with isAddAllProduct=true to add all products from a collection\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Authentication:\"\n }), \" Requires valid X-API-Key header\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a new subscription group (selling plan group)","description":"Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules.\n\n**Key Features:**\n- Create multiple subscription plans within a single group\n- Configure complex discount tiers (up to 2 levels + custom cycles)\n- Set up free trials with automatic discount transitions\n- Define prepaid plans (PAY_AS_YOU_GO_PREPAID) with custom billing cycles\n- Configure member-only plans with tag-based access control\n- Set specific delivery dates (e.g., 15th of every month)\n- Add all products from store or specific collection automatically\n\n**Discount Configuration:**\n- First discount tier: Applied from a specific cycle (afterCycle1)\n- Second discount tier: Applied from another cycle (afterCycle2)\n- Additional cycles: Configure via appstleCycles for complex scenarios\n- Free trials: Automatically configure 100% discount for trial period\n\n**Product Assignment:**\n- Assign specific products via productIds field in request body\n- Assign specific variants via variantIds field in request body\n- Use isAddAllProduct=true to add all store products\n- Use collectionId with isAddAllProduct=true to add all products from a collection\n\n**Authentication:** Requires valid X-API-Key header","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-groups","href":"/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules.\n\n**Key Features:**\n- Create multiple subscription plans within a single group\n- Configure complex discount tiers (up to 2 levels + custom cycles)\n- Set up free trials with automatic discount transitions\n- Define prepaid plans (PAY_AS_YOU_GO_PREPAID) with custom billing cycles\n- Configure member-only plans with tag-based access control\n- Set specific delivery dates (e.g., 15th of every month)\n- Add all products from store or specific collection automatically\n\n**Discount Configuration:**\n- First discount tier: Applied from a specific cycle (afterCycle1)\n- Second discount tier: Applied from another cycle (afterCycle2)\n- Additional cycles: Configure via appstleCycles for complex scenarios\n- Free trials: Automatically configure 100% discount for trial period\n\n**Product Assignment:**\n- Assign specific products via productIds field in request body\n- Assign specific variants via variantIds field in request body\n- Use isAddAllProduct=true to add all store products\n- Use collectionId with isAddAllProduct=true to add all products from a collection\n\n**Authentication:** Requires valid X-API-Key header","operationId":"createSubscriptionGroupV2External","parameters":["b3328e4c-9e2a-456d-88c2-426e24735d89","f142fc31-902f-4e69-a22f-0ba81b628e1b","3ded0802-0228-4fa0-a421-1f6cdb4f624a","18ff2608-bb5d-486d-9822-cacc425343fa"],"requestBody":"767a6d37-78bd-4494-b014-efeb72f4f9ba","responses":{"201":"0f3db846-98a8-404d-ad6f-29b7d76fd58c","400":"a12a99fb-299d-4455-b1d6-d221e2026e1c","401":"d7d24292-3057-4f24-9bd5-df6a16e70fb8","403":"48ba4f3a-fd1c-42f3-bbe4-f17d75ccf598","422":"d42b5181-aa7a-4dd9-be32-74feea68903f"},"summary":"Create a new subscription group (selling plan group)","tags":["Subscription Plans"],"method":"post","type":"path","servers":["d3c9e56f-e67b-483f-979d-9b57afc23940"],"security":[],"path":"/api/external/v2/subscription-groups","baseUrlOptions":["https://subscription-admin.appstle.com"],"title":"Create a new subscription group (selling plan group)","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","node","php","go","ruby"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b3328e4c-9e2a-456d-88c2-426e24735d89":{"deprecated":true,"description":"API Key (Deprecated - Use X-API-Key header instead)","in":"query","name":"api_key","required":false,"schema":{"type":"string","isRequired":false,"description":"API Key (Deprecated - Use X-API-Key header instead)","uniqueKey":"","typeLabel":"string"}},"f142fc31-902f-4e69-a22f-0ba81b628e1b":{"description":"API Key for authentication","example":"apst_your-api-key-here","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string","isRequired":true,"description":"API Key for authentication","uniqueKey":"","typeLabel":"string"}},"3ded0802-0228-4fa0-a421-1f6cdb4f624a":{"description":"Add all products from the store or collection to this subscription group. When true without collectionId: adds all active products in the store. When true with collectionId: adds all products from the specified collection. This operation runs asynchronously and may take time for large catalogs.","example":false,"in":"query","name":"isAddAllProduct","required":false,"schema":{"default":false,"type":"boolean","isRequired":false,"description":"Add all products from the store or collection to this subscription group. When true without collectionId: adds all active products in the store. When true with collectionId: adds all products from the specified collection. This operation runs asynchronously and may take time for large catalogs.","uniqueKey":"","typeLabel":"boolean"}},"18ff2608-bb5d-486d-9822-cacc425343fa":{"description":"Shopify collection ID to limit product addition when isAddAllProduct is true. Format: numeric ID without gid prefix (e.g., '123456789' not 'gid://shopify/Collection/123456789')","example":123456789,"in":"query","name":"collectionId","required":false,"schema":{"default":"","type":"string","isRequired":false,"description":"Shopify collection ID to limit product addition when isAddAllProduct is true. Format: numeric ID without gid prefix (e.g., '123456789' not 'gid://shopify/Collection/123456789')","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"examples":{"Complex Discount with Free Product":{"title":"Complex Discount with Free Product","description":"Complex Discount with Free Product","value":{"groupName":"Loyalty Rewards Subscription","productIds":"[{\"id\":987654321}]","subscriptionPlans":[{"afterCycle1":0,"appstleCycles":[{"afterCycle":6,"discountType":"FREE_PRODUCT","freeVariantId":42549172011164,"preventDuplicationFreeProduct":true},{"afterCycle":12,"discountType":"SHIPPING","repeatingCycle":true,"repeatingNumberOfCycle":3,"value":100}],"discountEnabled":true,"discountOffer":10,"discountType":"PERCENTAGE","frequencyCount":1,"frequencyDescription":"Earn rewards with every order","frequencyInterval":"MONTH","frequencyName":"Monthly with Rewards","planType":"PAY_AS_YOU_GO"}]}},"Free Trial Subscription":{"title":"Free Trial Subscription","description":"Free Trial Subscription","value":{"groupName":"Try Before You Subscribe","productIds":"[{\"id\":987654321}]","subscriptionPlans":[{"discountOffer":100,"discountOffer2":15,"freeTrialCount":14,"freeTrialEnabled":true,"freeTrialInterval":"DAY","frequencyCount":1,"frequencyDescription":"Try free for 14 days, then save 15%","frequencyInterval":"MONTH","frequencyName":"Monthly with 14-Day Trial","inventoryPolicyReserve":"ON_FULFILLMENT","minCycles":3,"planType":"PAY_AS_YOU_GO"}]}},"Member-Only Subscription":{"title":"Member-Only Subscription","description":"Member-Only Subscription","value":{"groupName":"VIP Member Subscriptions","productIds":"[{\"id\":987654321}]","subscriptionPlans":[{"afterCycle1":0,"discountEnabled":true,"discountOffer":25,"discountType":"PERCENTAGE","frequencyCount":1,"frequencyDescription":"Exclusive pricing for VIP members","frequencyInterval":"MONTH","frequencyName":"VIP Monthly Plan","memberExclusiveTags":"blocked,suspended","memberInclusiveTags":"vip,gold-member,platinum-member","memberOnly":true,"planType":"PAY_AS_YOU_GO"}]}},"Multi-tier Discount Plan":{"title":"Multi-tier Discount Plan","description":"Multi-tier Discount Plan","value":{"groupName":"Premium Subscription Plans","productIds":"[{\"id\":987654321},{\"id\":987654322}]","subscriptionPlans":[{"afterCycle1":0,"afterCycle2":4,"discountEnabled":true,"discountEnabled2":true,"discountOffer":5,"discountOffer2":10,"discountType":"PERCENTAGE","discountType2":"PERCENTAGE","frequencyCount":1,"frequencyDescription":"Save more with weekly deliveries","frequencyInterval":"WEEK","frequencyName":"Weekly Delivery","maxCycles":52,"minCycles":4,"planType":"PAY_AS_YOU_GO","upcomingOrderEmailBuffer":3},{"afterCycle1":0,"afterCycle2":6,"appstleCycles":[{"afterCycle":12,"discountType":"PERCENTAGE","repeatingCycle":true,"value":20}],"discountEnabled":true,"discountEnabled2":true,"discountOffer":10,"discountOffer2":15,"discountType":"PERCENTAGE","discountType2":"PERCENTAGE","frequencyCount":1,"frequencyDescription":"Convenient monthly shipments","frequencyInterval":"MONTH","frequencyName":"Monthly Delivery","planType":"PAY_AS_YOU_GO"}],"variantIds":"[{\"id\":123456789}]"}},"Prepaid Quarterly Plan":{"title":"Prepaid Quarterly Plan","description":"Prepaid Quarterly Plan","value":{"groupName":"Prepaid Quarterly Plans","productIds":"[{\"id\":987654321}]","subscriptionPlans":[{"discountEnabled":true,"discountOffer":20,"discountType":"PERCENTAGE","frequencyCount":1,"frequencyDescription":"Pay for 3 months upfront and save 20%","frequencyInterval":"MONTH","frequencyName":"3-Month Prepaid","maxCycles":12,"payAsYouGoPrepaidBillingFrequencyCount":3,"planType":"PAY_AS_YOU_GO_PREPAID"}]}},"Simple Monthly Subscription":{"title":"Simple Monthly Subscription","description":"Simple Monthly Subscription","value":{"groupName":"Monthly Coffee Subscription","productIds":"[{\"id\":987654321}]","subscriptionPlans":[{"afterCycle1":0,"discountEnabled":true,"discountOffer":10,"discountType":"PERCENTAGE","frequencyCount":1,"frequencyDescription":"Fresh coffee delivered every month","frequencyInterval":"MONTH","frequencyName":"Delivered Monthly","minCycles":3,"planType":"PAY_AS_YOU_GO"}]}},"Specific Day Delivery":{"title":"Specific Day Delivery","description":"Specific Day Delivery","value":{"groupName":"15th of Month Delivery","productIds":"[{\"id\":987654321}]","subscriptionPlans":[{"afterCycle1":0,"cutOff":5,"discountEnabled":true,"discountOffer":10,"discountType":"PERCENTAGE","frequencyCount":1,"frequencyDescription":"Delivered on the 15th of every month","frequencyInterval":"MONTH","frequencyName":"Monthly on the 15th","frequencyType":"ON_SPECIFIC_DAY","planType":"PAY_AS_YOU_GO","specificDayEnabled":true,"specificDayValue":15}]}}},"schema":{"properties":{"accessoryProductIds":{"type":"string","uniqueKey":"accessoryProductIds","typeLabel":"string"},"deleteProducts":{"properties":{"allProduct":{"type":"boolean","uniqueKey":"deleteProducts.allProduct","typeLabel":"boolean"},"collectionId":{"type":"string","uniqueKey":"deleteProducts.collectionId","typeLabel":"string"},"deleteAllProduct":{"type":"boolean","uniqueKey":"deleteProducts.deleteAllProduct","typeLabel":"boolean"},"productDetails":{"type":"string","uniqueKey":"deleteProducts.productDetails","typeLabel":"string"},"productIds":{"items":{"format":"int64","type":"integer","uniqueKey":"deleteProducts.productIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"type":"array","uniqueKey":"deleteProducts.productIds","typeLabel":"integer\u003cint64>[]"},"variantDetails":{"type":"string","uniqueKey":"deleteProducts.variantDetails","typeLabel":"string"},"variantIds":{"items":{"format":"int64","type":"integer","uniqueKey":"deleteProducts.variantIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"type":"array","uniqueKey":"deleteProducts.variantIds","typeLabel":"integer\u003cint64>[]"}},"type":"object","uniqueKey":"deleteProducts","typeLabel":"object"},"groupName":{"type":"string","uniqueKey":"groupName","typeLabel":"string"},"id":{"format":"int64","type":"integer","uniqueKey":"id","typeLabel":"integer\u003cint64>"},"productCount":{"format":"int64","type":"integer","uniqueKey":"productCount","typeLabel":"integer\u003cint64>"},"productId":{"type":"string","uniqueKey":"productId","typeLabel":"string"},"productIds":{"type":"string","uniqueKey":"productIds","typeLabel":"string"},"productVariantCount":{"format":"int64","type":"integer","uniqueKey":"productVariantCount","typeLabel":"integer\u003cint64>"},"subscriptionPlans":{"items":{"properties":{"afterCycle1":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].afterCycle1","typeLabel":"integer\u003cint32>"},"afterCycle2":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].afterCycle2","typeLabel":"integer\u003cint32>"},"appstleCycles":{"items":{"description":"Custom pricing cycle configuration for subscription line items","properties":{"afterCycle":{"description":"The billing cycle number after which this pricing applies","example":3,"format":"int32","minimum":1,"type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].afterCycle","typeLabel":"integer\u003cint32>"},"discountType":{"description":"Type of discount to apply in pricing cycles","enum":["PERCENTAGE","FIXED","PRICE","SHIPPING","FREE_PRODUCT","PERCENTAGE","FIXED","PRICE","SHIPPING","FREE_PRODUCT"],"example":"PERCENTAGE","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].discountType","typeLabel":"enum\u003cstring>"},"freeProductHandle":{"description":"Product handle of a free product to add when discountType is FREE_PRODUCT","example":"free-gift-product","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProductHandle","typeLabel":"string"},"freeProductImage":{"description":"Image URL of the free product when discountType is FREE_PRODUCT","example":"https://cdn.shopify.com/s/files/1/0000/0000/products/mug.jpg","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProductImage","typeLabel":"string"},"freeProductTitle":{"description":"Display title of the free product when discountType is FREE_PRODUCT","example":"Ceramic Mug","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProductTitle","typeLabel":"string"},"freeProducts":{"description":"One or more free products to gift when discountType is FREE_PRODUCT. Optional — when absent, the legacy singular freeVariantId/freeProductHandle/freeProductTitle/freeProductImage fields are the source of truth for a single free product. When present, index 0 is always mirrored onto those legacy fields so older clients keep working unchanged. Capped at 5 entries.","items":{"description":"A single free product gifted on a FREE_PRODUCT cycle rule","properties":{"freeProductHandle":{"description":"Product handle of the free product","example":"free-gift-product","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts.items.[INDEX].freeProductHandle","typeLabel":"string"},"freeProductImage":{"description":"Image URL of the free product","example":"https://cdn.shopify.com/s/files/1/0000/0000/products/mug.jpg","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts.items.[INDEX].freeProductImage","typeLabel":"string"},"freeProductTitle":{"description":"Display title of the free product","example":"Ceramic Mug","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts.items.[INDEX].freeProductTitle","typeLabel":"string"},"freeVariantId":{"description":"Variant ID of the free product","example":42549172011164,"format":"int64","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts.items.[INDEX].freeVariantId","typeLabel":"integer\u003cint64>"}},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts","typeLabel":"object[]"},"freeVariantId":{"description":"Variant ID of a free product to add when discountType is FREE_PRODUCT","example":42549172011164,"format":"int64","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeVariantId","typeLabel":"integer\u003cint64>"},"preventDuplicationFreeProduct":{"description":"Prevent adding duplicate free products if already in cart","example":true,"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].preventDuplicationFreeProduct","typeLabel":"boolean"},"repeatEvery":{"description":"Repeating rewards only: the repeating rewards come back every this many orders, counting the first order. A free gift on order 5 (afterCycle 4) with repeatEvery 5 is given on orders 5, 10, 15 and so on. When absent, they come back every N orders, where N is the highest afterCycle among the repeating rewards. Ignored on pay-as-you-go prepaid plans.","example":5,"format":"int32","maximum":150,"minimum":1,"type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].repeatEvery","typeLabel":"integer\u003cint32>"},"repeatingCycle":{"description":"Whether this pricing should repeat for subsequent cycles","example":true,"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].repeatingCycle","typeLabel":"boolean"},"repeatingNumberOfCycle":{"description":"Number of cycles to repeat this pricing for when repeatingCycle is true","example":6,"format":"int32","minimum":1,"type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].repeatingNumberOfCycle","typeLabel":"integer\u003cint32>"},"restrictFreeProductQuantity":{"description":"Keep each free product at quantity 1 regardless of the parent line item quantity","example":true,"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].restrictFreeProductQuantity","typeLabel":"boolean"},"singleOrder":{"description":"SHIPPING only: the shipping price covers this reward's own order, then the subscription goes back to its normal shipping price. Ignored on other reward types and on repeating rewards.","example":true,"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].singleOrder","typeLabel":"boolean"},"tierRole":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].tierRole","typeLabel":"string"},"value":{"description":"Discount value. For PERCENTAGE: 0-100 (e.g., 10 for 10% off). For FIXED: amount to subtract from price. For PRICE: new fixed price. For SHIPPING: shipping discount amount. For FREE_PRODUCT: not used (set freeVariantId or freeProductHandle instead)","example":10,"format":"double","type":"number","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].value","typeLabel":"number\u003cdouble>"}},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles","typeLabel":"object[]"},"billingFrequencyCount":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].billingFrequencyCount","typeLabel":"integer\u003cint32>"},"billingFrequencyInterval":{"enum":["DAY","WEEK","MONTH","YEAR"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].billingFrequencyInterval","typeLabel":"enum\u003cstring>"},"cutOff":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].cutOff","typeLabel":"integer\u003cint32>"},"defaultSelectedPlan":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].defaultSelectedPlan","typeLabel":"boolean"},"deliveryPolicyPreAnchorBehavior":{"enum":["ASAP","NEXT","$UNKNOWN"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].deliveryPolicyPreAnchorBehavior","typeLabel":"enum\u003cstring>"},"discountEnabled":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].discountEnabled","typeLabel":"boolean"},"discountEnabled2":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].discountEnabled2","typeLabel":"boolean"},"discountEnabled2Masked":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].discountEnabled2Masked","typeLabel":"boolean"},"discountEnabledMasked":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].discountEnabledMasked","typeLabel":"boolean"},"discountOffer":{"format":"double","type":"number","uniqueKey":"subscriptionPlans.items.[INDEX].discountOffer","typeLabel":"number\u003cdouble>"},"discountOffer2":{"format":"double","type":"number","uniqueKey":"subscriptionPlans.items.[INDEX].discountOffer2","typeLabel":"number\u003cdouble>"},"discountType":{"enum":["PERCENTAGE","FIXED","PRICE"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].discountType","typeLabel":"enum\u003cstring>"},"discountType2":{"enum":["PERCENTAGE","FIXED","PRICE"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].discountType2","typeLabel":"enum\u003cstring>"},"fixedBillingDates":{"items":{"properties":{"day":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].fixedBillingDates.items.[INDEX].day","typeLabel":"integer\u003cint32>"},"month":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].fixedBillingDates.items.[INDEX].month","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX].fixedBillingDates.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"subscriptionPlans.items.[INDEX].fixedBillingDates","typeLabel":"object[]"},"formFieldJson":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].formFieldJson","typeLabel":"string"},"freeTrialCount":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].freeTrialCount","typeLabel":"integer\u003cint32>"},"freeTrialEnabled":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].freeTrialEnabled","typeLabel":"boolean"},"freeTrialInterval":{"enum":["DAY","WEEK","MONTH","YEAR"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].freeTrialInterval","typeLabel":"enum\u003cstring>"},"frequencyCount":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyCount","typeLabel":"integer\u003cint32>"},"frequencyDescription":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyDescription","typeLabel":"string"},"frequencyInterval":{"enum":["DAY","WEEK","MONTH","YEAR"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyInterval","typeLabel":"enum\u003cstring>"},"frequencyName":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyName","typeLabel":"string"},"frequencyNameTranslations":{"additionalProperties":{"additionalProperties":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyNameTranslations.additionalProperties.additionalProperties","typeLabel":"string"},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyNameTranslations.additionalProperties","typeLabel":"object"},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyNameTranslations","typeLabel":"object"},"frequencySequence":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].frequencySequence","typeLabel":"integer\u003cint32>"},"frequencyType":{"enum":["ON_PURCHASE_DAY","ON_SPECIFIC_DAY","ON_FIXED_DATES"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyType","typeLabel":"enum\u003cstring>"},"gift":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].gift","typeLabel":"boolean"},"giftSendMaxDays":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].giftSendMaxDays","typeLabel":"integer\u003cint32>"},"groupId":{"format":"int64","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].groupId","typeLabel":"integer\u003cint64>"},"groupName":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].groupName","typeLabel":"string"},"id":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].id","typeLabel":"string"},"idNew":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].idNew","typeLabel":"string"},"inventoryPolicyReserve":{"enum":["ON_FULFILLMENT","ON_SALE","$UNKNOWN"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].inventoryPolicyReserve","typeLabel":"enum\u003cstring>"},"keepOriginalNextBillingDateAfterTrial":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].keepOriginalNextBillingDateAfterTrial","typeLabel":"boolean"},"maxCycles":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].maxCycles","typeLabel":"integer\u003cint32>"},"memberExclusiveTags":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].memberExclusiveTags","typeLabel":"string"},"memberInclusiveTags":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].memberInclusiveTags","typeLabel":"string"},"memberOnly":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].memberOnly","typeLabel":"boolean"},"minCycles":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].minCycles","typeLabel":"integer\u003cint32>"},"minQuantity":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].minQuantity","typeLabel":"integer\u003cint32>"},"nonMemberOnly":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].nonMemberOnly","typeLabel":"boolean"},"payAsYouGoPrepaidBillingFrequencyCount":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].payAsYouGoPrepaidBillingFrequencyCount","typeLabel":"integer\u003cint32>"},"planType":{"enum":["PAY_AS_YOU_GO","PREPAID","ADVANCED_PREPAID","PAY_AS_YOU_GO_PREPAID"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].planType","typeLabel":"enum\u003cstring>"},"prepaidFlag":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].prepaidFlag","typeLabel":"string"},"repeatingCycle":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].repeatingCycle","typeLabel":"boolean"},"repeatingNumberOfCycle":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].repeatingNumberOfCycle","typeLabel":"integer\u003cint32>"},"specificDayEnabled":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].specificDayEnabled","typeLabel":"boolean"},"specificDayValue":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].specificDayValue","typeLabel":"integer\u003cint32>"},"specificMonthValue":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].specificMonthValue","typeLabel":"integer\u003cint32>"},"upcomingOrderEmailBuffer":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].upcomingOrderEmailBuffer","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"subscriptionPlans","typeLabel":"object[]"},"translations":{"type":"string","uniqueKey":"translations","typeLabel":"string"},"updateProducts":{"properties":{"allProduct":{"type":"boolean","uniqueKey":"updateProducts.allProduct","typeLabel":"boolean"},"collectionId":{"type":"string","uniqueKey":"updateProducts.collectionId","typeLabel":"string"},"deleteAllProduct":{"type":"boolean","uniqueKey":"updateProducts.deleteAllProduct","typeLabel":"boolean"},"productDetails":{"type":"string","uniqueKey":"updateProducts.productDetails","typeLabel":"string"},"productIds":{"items":{"format":"int64","type":"integer","uniqueKey":"updateProducts.productIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"type":"array","uniqueKey":"updateProducts.productIds","typeLabel":"integer\u003cint64>[]"},"variantDetails":{"type":"string","uniqueKey":"updateProducts.variantDetails","typeLabel":"string"},"variantIds":{"items":{"format":"int64","type":"integer","uniqueKey":"updateProducts.variantIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"type":"array","uniqueKey":"updateProducts.variantIds","typeLabel":"integer\u003cint64>[]"}},"type":"object","uniqueKey":"updateProducts","typeLabel":"object"},"variantIds":{"type":"string","uniqueKey":"variantIds","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Complete subscription group configuration including name, plans, and product assignments","required":true,"exampleType":"examples"},"responses":{"0f3db846-98a8-404d-ad6f-29b7d76fd58c":{"content":{"application/json":{"examples":{"Success Response":{"title":"Success Response","description":"Success Response","value":{"groupName":"Monthly Coffee Subscription","id":123456789,"productCount":5,"productIds":"[{\"id\":987654321,\"title\":\"Premium Coffee Blend\",\"status\":\"ACTIVE\"}]","productVariantCount":15,"subscriptionPlans":[{"afterCycle1":0,"afterCycle2":3,"billingFrequencyCount":1,"billingFrequencyInterval":"MONTH","discountEnabled":true,"discountEnabled2":true,"discountOffer":10,"discountOffer2":15,"discountType":"PERCENTAGE","discountType2":"PERCENTAGE","frequencyCount":1,"frequencyDescription":"Get fresh coffee delivered to your door every month","frequencyInterval":"MONTH","frequencyName":"Delivered Monthly","frequencySequence":0,"id":"gid://shopify/SellingPlan/111111","maxCycles":null,"minCycles":3,"planType":"PAY_AS_YOU_GO"}],"variantIds":"[]"}}},"schema":{"properties":{"accessoryProductIds":{"type":"string","uniqueKey":"accessoryProductIds","typeLabel":"string"},"deleteProducts":{"properties":{"allProduct":{"type":"boolean","uniqueKey":"deleteProducts.allProduct","typeLabel":"boolean"},"collectionId":{"type":"string","uniqueKey":"deleteProducts.collectionId","typeLabel":"string"},"deleteAllProduct":{"type":"boolean","uniqueKey":"deleteProducts.deleteAllProduct","typeLabel":"boolean"},"productDetails":{"type":"string","uniqueKey":"deleteProducts.productDetails","typeLabel":"string"},"productIds":{"items":{"format":"int64","type":"integer","uniqueKey":"deleteProducts.productIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"type":"array","uniqueKey":"deleteProducts.productIds","typeLabel":"integer\u003cint64>[]"},"variantDetails":{"type":"string","uniqueKey":"deleteProducts.variantDetails","typeLabel":"string"},"variantIds":{"items":{"format":"int64","type":"integer","uniqueKey":"deleteProducts.variantIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"type":"array","uniqueKey":"deleteProducts.variantIds","typeLabel":"integer\u003cint64>[]"}},"type":"object","uniqueKey":"deleteProducts","typeLabel":"object"},"groupName":{"type":"string","uniqueKey":"groupName","typeLabel":"string"},"id":{"format":"int64","type":"integer","uniqueKey":"id","typeLabel":"integer\u003cint64>"},"productCount":{"format":"int64","type":"integer","uniqueKey":"productCount","typeLabel":"integer\u003cint64>"},"productId":{"type":"string","uniqueKey":"productId","typeLabel":"string"},"productIds":{"type":"string","uniqueKey":"productIds","typeLabel":"string"},"productVariantCount":{"format":"int64","type":"integer","uniqueKey":"productVariantCount","typeLabel":"integer\u003cint64>"},"subscriptionPlans":{"items":{"properties":{"afterCycle1":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].afterCycle1","typeLabel":"integer\u003cint32>"},"afterCycle2":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].afterCycle2","typeLabel":"integer\u003cint32>"},"appstleCycles":{"items":{"description":"Custom pricing cycle configuration for subscription line items","properties":{"afterCycle":{"description":"The billing cycle number after which this pricing applies","example":3,"format":"int32","minimum":1,"type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].afterCycle","typeLabel":"integer\u003cint32>"},"discountType":{"description":"Type of discount to apply in pricing cycles","enum":["PERCENTAGE","FIXED","PRICE","SHIPPING","FREE_PRODUCT","PERCENTAGE","FIXED","PRICE","SHIPPING","FREE_PRODUCT"],"example":"PERCENTAGE","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].discountType","typeLabel":"enum\u003cstring>"},"freeProductHandle":{"description":"Product handle of a free product to add when discountType is FREE_PRODUCT","example":"free-gift-product","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProductHandle","typeLabel":"string"},"freeProductImage":{"description":"Image URL of the free product when discountType is FREE_PRODUCT","example":"https://cdn.shopify.com/s/files/1/0000/0000/products/mug.jpg","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProductImage","typeLabel":"string"},"freeProductTitle":{"description":"Display title of the free product when discountType is FREE_PRODUCT","example":"Ceramic Mug","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProductTitle","typeLabel":"string"},"freeProducts":{"description":"One or more free products to gift when discountType is FREE_PRODUCT. Optional — when absent, the legacy singular freeVariantId/freeProductHandle/freeProductTitle/freeProductImage fields are the source of truth for a single free product. When present, index 0 is always mirrored onto those legacy fields so older clients keep working unchanged. Capped at 5 entries.","items":{"description":"A single free product gifted on a FREE_PRODUCT cycle rule","properties":{"freeProductHandle":{"description":"Product handle of the free product","example":"free-gift-product","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts.items.[INDEX].freeProductHandle","typeLabel":"string"},"freeProductImage":{"description":"Image URL of the free product","example":"https://cdn.shopify.com/s/files/1/0000/0000/products/mug.jpg","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts.items.[INDEX].freeProductImage","typeLabel":"string"},"freeProductTitle":{"description":"Display title of the free product","example":"Ceramic Mug","type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts.items.[INDEX].freeProductTitle","typeLabel":"string"},"freeVariantId":{"description":"Variant ID of the free product","example":42549172011164,"format":"int64","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts.items.[INDEX].freeVariantId","typeLabel":"integer\u003cint64>"}},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeProducts","typeLabel":"object[]"},"freeVariantId":{"description":"Variant ID of a free product to add when discountType is FREE_PRODUCT","example":42549172011164,"format":"int64","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].freeVariantId","typeLabel":"integer\u003cint64>"},"preventDuplicationFreeProduct":{"description":"Prevent adding duplicate free products if already in cart","example":true,"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].preventDuplicationFreeProduct","typeLabel":"boolean"},"repeatEvery":{"description":"Repeating rewards only: the repeating rewards come back every this many orders, counting the first order. A free gift on order 5 (afterCycle 4) with repeatEvery 5 is given on orders 5, 10, 15 and so on. When absent, they come back every N orders, where N is the highest afterCycle among the repeating rewards. Ignored on pay-as-you-go prepaid plans.","example":5,"format":"int32","maximum":150,"minimum":1,"type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].repeatEvery","typeLabel":"integer\u003cint32>"},"repeatingCycle":{"description":"Whether this pricing should repeat for subsequent cycles","example":true,"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].repeatingCycle","typeLabel":"boolean"},"repeatingNumberOfCycle":{"description":"Number of cycles to repeat this pricing for when repeatingCycle is true","example":6,"format":"int32","minimum":1,"type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].repeatingNumberOfCycle","typeLabel":"integer\u003cint32>"},"restrictFreeProductQuantity":{"description":"Keep each free product at quantity 1 regardless of the parent line item quantity","example":true,"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].restrictFreeProductQuantity","typeLabel":"boolean"},"singleOrder":{"description":"SHIPPING only: the shipping price covers this reward's own order, then the subscription goes back to its normal shipping price. Ignored on other reward types and on repeating rewards.","example":true,"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].singleOrder","typeLabel":"boolean"},"tierRole":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].tierRole","typeLabel":"string"},"value":{"description":"Discount value. For PERCENTAGE: 0-100 (e.g., 10 for 10% off). For FIXED: amount to subtract from price. For PRICE: new fixed price. For SHIPPING: shipping discount amount. For FREE_PRODUCT: not used (set freeVariantId or freeProductHandle instead)","example":10,"format":"double","type":"number","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX].value","typeLabel":"number\u003cdouble>"}},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"subscriptionPlans.items.[INDEX].appstleCycles","typeLabel":"object[]"},"billingFrequencyCount":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].billingFrequencyCount","typeLabel":"integer\u003cint32>"},"billingFrequencyInterval":{"enum":["DAY","WEEK","MONTH","YEAR"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].billingFrequencyInterval","typeLabel":"enum\u003cstring>"},"cutOff":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].cutOff","typeLabel":"integer\u003cint32>"},"defaultSelectedPlan":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].defaultSelectedPlan","typeLabel":"boolean"},"deliveryPolicyPreAnchorBehavior":{"enum":["ASAP","NEXT","$UNKNOWN"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].deliveryPolicyPreAnchorBehavior","typeLabel":"enum\u003cstring>"},"discountEnabled":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].discountEnabled","typeLabel":"boolean"},"discountEnabled2":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].discountEnabled2","typeLabel":"boolean"},"discountEnabled2Masked":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].discountEnabled2Masked","typeLabel":"boolean"},"discountEnabledMasked":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].discountEnabledMasked","typeLabel":"boolean"},"discountOffer":{"format":"double","type":"number","uniqueKey":"subscriptionPlans.items.[INDEX].discountOffer","typeLabel":"number\u003cdouble>"},"discountOffer2":{"format":"double","type":"number","uniqueKey":"subscriptionPlans.items.[INDEX].discountOffer2","typeLabel":"number\u003cdouble>"},"discountType":{"enum":["PERCENTAGE","FIXED","PRICE"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].discountType","typeLabel":"enum\u003cstring>"},"discountType2":{"enum":["PERCENTAGE","FIXED","PRICE"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].discountType2","typeLabel":"enum\u003cstring>"},"fixedBillingDates":{"items":{"properties":{"day":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].fixedBillingDates.items.[INDEX].day","typeLabel":"integer\u003cint32>"},"month":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].fixedBillingDates.items.[INDEX].month","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX].fixedBillingDates.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"subscriptionPlans.items.[INDEX].fixedBillingDates","typeLabel":"object[]"},"formFieldJson":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].formFieldJson","typeLabel":"string"},"freeTrialCount":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].freeTrialCount","typeLabel":"integer\u003cint32>"},"freeTrialEnabled":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].freeTrialEnabled","typeLabel":"boolean"},"freeTrialInterval":{"enum":["DAY","WEEK","MONTH","YEAR"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].freeTrialInterval","typeLabel":"enum\u003cstring>"},"frequencyCount":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyCount","typeLabel":"integer\u003cint32>"},"frequencyDescription":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyDescription","typeLabel":"string"},"frequencyInterval":{"enum":["DAY","WEEK","MONTH","YEAR"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyInterval","typeLabel":"enum\u003cstring>"},"frequencyName":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyName","typeLabel":"string"},"frequencyNameTranslations":{"additionalProperties":{"additionalProperties":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyNameTranslations.additionalProperties.additionalProperties","typeLabel":"string"},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyNameTranslations.additionalProperties","typeLabel":"object"},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyNameTranslations","typeLabel":"object"},"frequencySequence":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].frequencySequence","typeLabel":"integer\u003cint32>"},"frequencyType":{"enum":["ON_PURCHASE_DAY","ON_SPECIFIC_DAY","ON_FIXED_DATES"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].frequencyType","typeLabel":"enum\u003cstring>"},"gift":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].gift","typeLabel":"boolean"},"giftSendMaxDays":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].giftSendMaxDays","typeLabel":"integer\u003cint32>"},"groupId":{"format":"int64","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].groupId","typeLabel":"integer\u003cint64>"},"groupName":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].groupName","typeLabel":"string"},"id":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].id","typeLabel":"string"},"idNew":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].idNew","typeLabel":"string"},"inventoryPolicyReserve":{"enum":["ON_FULFILLMENT","ON_SALE","$UNKNOWN"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].inventoryPolicyReserve","typeLabel":"enum\u003cstring>"},"keepOriginalNextBillingDateAfterTrial":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].keepOriginalNextBillingDateAfterTrial","typeLabel":"boolean"},"maxCycles":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].maxCycles","typeLabel":"integer\u003cint32>"},"memberExclusiveTags":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].memberExclusiveTags","typeLabel":"string"},"memberInclusiveTags":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].memberInclusiveTags","typeLabel":"string"},"memberOnly":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].memberOnly","typeLabel":"boolean"},"minCycles":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].minCycles","typeLabel":"integer\u003cint32>"},"minQuantity":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].minQuantity","typeLabel":"integer\u003cint32>"},"nonMemberOnly":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].nonMemberOnly","typeLabel":"boolean"},"payAsYouGoPrepaidBillingFrequencyCount":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].payAsYouGoPrepaidBillingFrequencyCount","typeLabel":"integer\u003cint32>"},"planType":{"enum":["PAY_AS_YOU_GO","PREPAID","ADVANCED_PREPAID","PAY_AS_YOU_GO_PREPAID"],"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].planType","typeLabel":"enum\u003cstring>"},"prepaidFlag":{"type":"string","uniqueKey":"subscriptionPlans.items.[INDEX].prepaidFlag","typeLabel":"string"},"repeatingCycle":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].repeatingCycle","typeLabel":"boolean"},"repeatingNumberOfCycle":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].repeatingNumberOfCycle","typeLabel":"integer\u003cint32>"},"specificDayEnabled":{"type":"boolean","uniqueKey":"subscriptionPlans.items.[INDEX].specificDayEnabled","typeLabel":"boolean"},"specificDayValue":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].specificDayValue","typeLabel":"integer\u003cint32>"},"specificMonthValue":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].specificMonthValue","typeLabel":"integer\u003cint32>"},"upcomingOrderEmailBuffer":{"format":"int32","type":"integer","uniqueKey":"subscriptionPlans.items.[INDEX].upcomingOrderEmailBuffer","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"subscriptionPlans.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"subscriptionPlans","typeLabel":"object[]"},"translations":{"type":"string","uniqueKey":"translations","typeLabel":"string"},"updateProducts":{"properties":{"allProduct":{"type":"boolean","uniqueKey":"updateProducts.allProduct","typeLabel":"boolean"},"collectionId":{"type":"string","uniqueKey":"updateProducts.collectionId","typeLabel":"string"},"deleteAllProduct":{"type":"boolean","uniqueKey":"updateProducts.deleteAllProduct","typeLabel":"boolean"},"productDetails":{"type":"string","uniqueKey":"updateProducts.productDetails","typeLabel":"string"},"productIds":{"items":{"format":"int64","type":"integer","uniqueKey":"updateProducts.productIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"type":"array","uniqueKey":"updateProducts.productIds","typeLabel":"integer\u003cint64>[]"},"variantDetails":{"type":"string","uniqueKey":"updateProducts.variantDetails","typeLabel":"string"},"variantIds":{"items":{"format":"int64","type":"integer","uniqueKey":"updateProducts.variantIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"type":"array","uniqueKey":"updateProducts.variantIds","typeLabel":"integer\u003cint64>[]"}},"type":"object","uniqueKey":"updateProducts","typeLabel":"object"},"variantIds":{"type":"string","uniqueKey":"variantIds","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Subscription group successfully created","exampleType":"examples"},"a12a99fb-299d-4455-b1d6-d221e2026e1c":{"content":{"application/json":{"examples":{"ID Already Exists":{"title":"ID Already Exists","description":"ID Already Exists","value":{"detail":"A new subscriptionGroup cannot already have an ID","errorKey":"idexists","status":400,"title":"Bad Request","type":"https://example.com/errors/bad-request"}},"Invalid Frequency Configuration":{"title":"Invalid Frequency Configuration","description":"Invalid Frequency Configuration","value":{"detail":"Frequency count must be greater than 0","status":400,"title":"Bad Request","type":"https://example.com/errors/bad-request"}},"Missing Required Fields":{"title":"Missing Required Fields","description":"Missing Required Fields","value":{"detail":"Group name is required","status":400,"title":"Bad Request","type":"https://example.com/errors/bad-request"}}},"exampleType":"examples"}},"description":"Invalid request parameters or validation error","exampleType":"examples"},"d7d24292-3057-4f24-9bd5-df6a16e70fb8":{"content":{"application/json":{"example":{"detail":"Invalid or missing API key","status":401,"title":"Unauthorized","type":"https://example.com/errors/unauthorized"},"examples":{"Example":{"title":"Example","value":{"detail":"Invalid or missing API key","status":401,"title":"Unauthorized","type":"https://example.com/errors/unauthorized"}}},"exampleType":"examples"}},"description":"Authentication required - missing or invalid API key","exampleType":"examples"},"48ba4f3a-fd1c-42f3-bbe4-f17d75ccf598":{"content":{"application/json":{"example":{"detail":"You do not have permission to create subscription groups","status":403,"title":"Forbidden","type":"https://example.com/errors/forbidden"},"examples":{"Example":{"title":"Example","value":{"detail":"You do not have permission to create subscription groups","status":403,"title":"Forbidden","type":"https://example.com/errors/forbidden"}}},"exampleType":"examples"}},"description":"Insufficient permissions to create subscription groups","exampleType":"examples"},"d42b5181-aa7a-4dd9-be32-74feea68903f":{"content":{"application/json":{"examples":{"Duplicate Plan Name":{"title":"Duplicate Plan Name","description":"Duplicate Plan Name","value":{"detail":"A selling plan group with this name already exists","status":422,"title":"Unprocessable Entity","type":"https://example.com/errors/unprocessable-entity"}},"Shopify API Error":{"title":"Shopify API Error","description":"Shopify API Error","value":{"detail":"Shopify API error: Product not found","status":422,"title":"Unprocessable Entity","type":"https://example.com/errors/unprocessable-entity"}}},"exampleType":"examples"}},"description":"Shopify API error or business rule violation","exampleType":"examples"}},"security":{},"servers":{"d3c9e56f-e67b-483f-979d-9b57afc23940":{"url":"https://subscription-admin.appstle.com"}}},"originalFileLocation":"subscription/admin-api-swagger.json"},"subdomain":"appstleinc-aeca3e0a","siteName":"Appstle","title":"Create a new subscription group (selling plan group) - Appstle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-08T12:41:24.650Z","originalFileLocation":"subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules. Key Features: - Create multiple subscription plans within a single group - Configure complex discount tiers (up to 2 levels + custom cycles) - Set up free trials with automatic discount transitions - Define prepaid plans (PAY_AS_YOU_GO_PREPAID) with custom billing cycles - Configure member-only plans with tag-based access control - Set specific delivery dates (e.g., 15th of every month) - Add all products from store or specific collection automatically Discount Configuration: - First discount tier: Applied from a specific cycle (afterCycle1) - Second discount tier: Applied from another cycle (afterCycle2) - Additional cycles: Configure via appstleCycles for complex scenarios - Free trials: Automatically configure 100% discount for trial period Product Assignment: - Assign specific products via productIds field in request body - Assign specific variants via variantIds field in request body - Use isAddAllProduct=true to add all store products - Use collectionId with isAddAllProduct=true to add all products from a collection Authentication: Requires valid X-API-Key header\">\u003cmeta data-mint-head name=\"application-name\" content=\"Appstle\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a new subscription group (selling plan group) - Appstle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules. Key Features: - Create multiple subscription plans within a single group - Configure complex discount tiers (up to 2 levels + custom cycles) - Set up free trials with automatic discount transitions - Define prepaid plans (PAY_AS_YOU_GO_PREPAID) with custom billing cycles - Configure member-only plans with tag-based access control - Set specific delivery dates (e.g., 15th of every month) - Add all products from store or specific collection automatically Discount Configuration: - First discount tier: Applied from a specific cycle (afterCycle1) - Second discount tier: Applied from another cycle (afterCycle2) - Additional cycles: Configure via appstleCycles for complex scenarios - Free trials: Automatically configure 100% discount for trial period Product Assignment: - Assign specific products via productIds field in request body - Assign specific variants via variantIds field in request body - Use isAddAllProduct=true to add all store products - Use collectionId with isAddAllProduct=true to add all products from a collection Authentication: Requires valid X-API-Key header\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Appstle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.appstle.com/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://appstleinc-aeca3e0a.mintlify.site/_mintlify/api/og/v2?division=Subscription+Plans\u0026amp;title=Create+a+new+subscription+group+%28selling+plan+group%29\u0026amp;description=Creates+a+new+subscription+group+with+one+or+more+selling+plans+in+Shopify.+A+subscription+group+is+a+container+for+selling+plans+that+can+be+applied+to+product\u0026amp;theme=5c3420c08540c444b143045f\u0026amp;signature=8432362d80592fc08a4feff82d71fc11680f85876d5b8ea424b48514f2fe668a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a new subscription group (selling plan group) - Appstle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules. Key Features: - Create multiple subscription plans within a single group - Configure complex discount tiers (up to 2 levels + custom cycles) - Set up free trials with automatic discount transitions - Define prepaid plans (PAY_AS_YOU_GO_PREPAID) with custom billing cycles - Configure member-only plans with tag-based access control - Set specific delivery dates (e.g., 15th of every month) - Add all products from store or specific collection automatically Discount Configuration: - First discount tier: Applied from a specific cycle (afterCycle1) - Second discount tier: Applied from another cycle (afterCycle2) - Additional cycles: Configure via appstleCycles for complex scenarios - Free trials: Automatically configure 100% discount for trial period Product Assignment: - Assign specific products via productIds field in request body - Assign specific variants via variantIds field in request body - Use isAddAllProduct=true to add all store products - Use collectionId with isAddAllProduct=true to add all products from a collection Authentication: Requires valid X-API-Key header\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://appstleinc-aeca3e0a.mintlify.site/_mintlify/api/og/v2?division=Subscription+Plans\u0026amp;title=Create+a+new+subscription+group+%28selling+plan+group%29\u0026amp;description=Creates+a+new+subscription+group+with+one+or+more+selling+plans+in+Shopify.+A+subscription+group+is+a+container+for+selling+plans+that+can+be+applied+to+product\u0026amp;theme=5c3420c08540c444b143045f\u0026amp;signature=8432362d80592fc08a4feff82d71fc11680f85876d5b8ea424b48514f2fe668a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Appstle\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0caceb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.appstle.com/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.appstle.com/#organization\",\"name\":\"Appstle\",\"url\":\"https://developers.appstle.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://developers.appstle.com#website\",\"name\":\"Appstle\",\"url\":\"https://developers.appstle.com\",\"publisher\":{\"@id\":\"https://developers.appstle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.appstle.com/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group#webpage\",\"url\":\"https://developers.appstle.com/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group\",\"name\":\"Create a new subscription group (selling plan group)\",\"description\":\"Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules. Key Features: - Create multiple subscription plans within a single group - Configure complex discount tiers (up to 2 levels + custom cycles) - Set up free trials with automatic discount transitions - Define prepaid plans (PAY_AS_YOU_GO_PREPAID) with custom billing cycles - Configure member-only plans with tag-based access control - Set specific delivery dates (e.g., 15th of every month) - Add all products from store or specific collection automatically Discount Configuration: - First discount tier: Applied from a specific cycle (afterCycle1) - Second discount tier: Applied from another cycle (afterCycle2) - Additional cycles: Configure via appstleCycles for complex scenarios - Free trials: Automatically configure 100% discount for trial period Product Assignment: - Assign specific products via productIds field in request body - Assign specific variants via variantIds field in request body - Use isAddAllProduct=true to add all store products - Use collectionId with isAddAllProduct=true to add all products from a collection Authentication: Requires valid X-API-Key header\",\"dateModified\":\"2026-11-08T12:41:24.650Z\",\"isPartOf\":{\"@id\":\"https://developers.appstle.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.appstle.com/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.appstle.com/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Admin API\",\"item\":\"https://developers.appstle.com/subscription-admin-api/operations-\u0026-settings/getsearch-activity-logs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Subscription Plans\",\"item\":\"https://developers.appstle.com/subscription-admin-api/subscription-plans/get-all-subscription-groups\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a new subscription group (selling plan group)\",\"item\":\"https://developers.appstle.com/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.appstle.com/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group#apireference\",\"headline\":\"Create a new subscription group (selling plan group)\",\"name\":\"Create a new subscription group (selling plan group)\",\"description\":\"Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules. Key Features: - Create multiple subscription plans within a single group - Configure complex discount tiers (up to 2 levels + custom cycles) - Set up free trials with automatic discount transitions - Define prepaid plans (PAY_AS_YOU_GO_PREPAID) with custom billing cycles - Configure member-only plans with tag-based access control - Set specific delivery dates (e.g., 15th of every month) - Add all products from store or specific collection automatically Discount Configuration: - First discount tier: Applied from a specific cycle (afterCycle1) - Second discount tier: Applied from another cycle (afterCycle2) - Additional cycles: Configure via appstleCycles for complex scenarios - Free trials: Automatically configure 100% discount for trial period Product Assignment: - Assign specific products via productIds field in request body - Assign specific variants via variantIds field in request body - Use isAddAllProduct=true to add all store products - Use collectionId with isAddAllProduct=true to add all products from a collection Authentication: Requires valid X-API-Key header\",\"url\":\"https://developers.appstle.com/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group\",\"mainEntityOfPage\":{\"@id\":\"https://developers.appstle.com/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group#webpage\"},\"dateModified\":\"2026-11-08T12:41:24.650Z\",\"publisher\":{\"@id\":\"https://developers.appstle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.appstle.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Appstle\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Appstle\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group.md","siteName":"Appstle","nav":{"global":null,"tabs":[{"tab":"Subscriptions","icon":"arrows-rotate","groups":[{"group":"Get started","pages":[{"title":"Appstle Subscriptions: Recurring Revenue for Shopify","sidebarTitle":"Introduction","href":"/subscription/introduction"},{"title":"Authenticate with the Appstle Subscriptions API","sidebarTitle":"Authentication","href":"/subscription/authentication"},{"title":"Get started with Appstle Subscriptions API","sidebarTitle":"Quickstart","href":"/subscription/quickstart"}]},{"group":"Backend integration","pages":[{"title":"Appstle Subscriptions integration guide","sidebarTitle":"Integration guide","href":"/subscription/integration-guide"},{"title":"Appstle Subscriptions webhook events and setup","sidebarTitle":"Webhooks","href":"/subscription/webhooks"},{"title":"Automate subscriptions with Shopify Flow","sidebarTitle":"Shopify Flow","href":"/subscription/shopify-flow"}]},{"group":"Storefront integration","pages":[{"title":"Build your own subscription frontend","sidebarTitle":"Build your own frontend","href":"/subscription/build-your-own-frontend"},{"title":"Build a Dynamic Pricing Build-a-Box with a custom UI","sidebarTitle":"Dynamic Pricing Build-a-Box","href":"/subscription/dynamic-pricing-box-custom-ui"},{"title":"Build a fixed-price Build-a-Box with a custom UI","sidebarTitle":"Fixed-price Build-a-Box","href":"/subscription/fixed-price-box-custom-ui"},{"title":"Sell gift subscriptions from your own storefront","sidebarTitle":"Gift subscriptions","href":"/subscription/gift-subscriptions"},{"title":"JavaScript events for the Appstle storefront widget","sidebarTitle":"JavaScript hooks","href":"/subscription/javascript-hooks"},{"title":"Shopify metafields and tags for Appstle Subscriptions","sidebarTitle":"Metafields \u0026 tags","href":"/subscription/metafields-and-tags"}]},{"group":"Partner integration","pages":[{"title":"Partner Integration Framework overview","sidebarTitle":"Framework overview","href":"/subscription/partner-framework-overview"},{"title":"Partner Integration Framework","sidebarTitle":"Partner integration","href":"/subscription/partner-integration"}]},{"group":"Resources","pages":[{"title":"Appstle Subscriptions API changelog","sidebarTitle":"API changelog","href":"/subscription/api-changelog"},{"title":"Appstle Subscriptions frequently asked questions","sidebarTitle":"FAQ","href":"/subscription/faq"}]},{"group":"Admin API","pages":[{"group":"Operations \u0026 Settings","pages":[{"title":"Get/Search activity logs","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/activity-logs","href":"/subscription-admin-api/operations-\u0026-settings/getsearch-activity-logs"},{"title":"Bulk update subscription billing interval","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/bulk-automations/billing-interval","href":"/subscription-admin-api/operations-\u0026-settings/bulk-update-subscription-billing-interval"},{"title":"Bulk update subscription delivery method","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/bulk-automations/delivery-method","href":"/subscription-admin-api/operations-\u0026-settings/bulk-update-subscription-delivery-method"},{"title":"Bulk update subscription delivery price","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/bulk-automations/delivery-price","href":"/subscription-admin-api/operations-\u0026-settings/bulk-update-subscription-delivery-price"},{"title":"Hide subscriptions in bulk","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/bulk-automations/hide-subscriptions","href":"/subscription-admin-api/operations-\u0026-settings/hide-subscriptions-in-bulk"},{"title":"Replace products in subscriptions in bulk","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/bulk-automations/replace-product","href":"/subscription-admin-api/operations-\u0026-settings/replace-products-in-subscriptions-in-bulk"},{"title":"Get cancellation management configuration","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/cancellation-managements/{id}","href":"/subscription-admin-api/operations-\u0026-settings/get-cancellation-management-configuration"},{"title":"Create a new shipping/delivery profile","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/delivery-profiles/create-shipping-profile","href":"/subscription-admin-api/operations-\u0026-settings/create-a-new-shippingdelivery-profile"},{"title":"Create a new shipping/delivery profile (V2)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/delivery-profiles/v2/create-shipping-profile","href":"/subscription-admin-api/operations-\u0026-settings/create-a-new-shippingdelivery-profile-v2"},{"title":"Create a new shipping/delivery profile (V3)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/delivery-profiles/v3/create-shipping-profile","href":"/subscription-admin-api/operations-\u0026-settings/create-a-new-shippingdelivery-profile-v3"}]},{"group":"Subscription Contracts","pages":[{"title":"Associate external payment gateway customer with Shopify customer","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/associate-shopify-customer-to-external-payment-gateways","href":"/subscription-admin-api/subscription-contracts/associate-external-payment-gateway-customer-with-shopify-customer"},{"title":"Retrieve raw Shopify GraphQL response for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/contract-raw-response","href":"/subscription-admin-api/subscription-contracts/retrieve-raw-shopify-graphql-response-for-a-subscription-contract"},{"title":"Generate customer portal authentication token","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/customer-portal-token","href":"/subscription-admin-api/subscription-contracts/generate-customer-portal-authentication-token"},{"title":"Retrieve subscription contracts","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details","href":"/subscription-admin-api/subscription-contracts/retrieve-subscription-contracts"},{"title":"Add custom discount to subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-add-discount","href":"/subscription-admin-api/subscription-contracts/add-custom-discount-to-subscription"},{"title":"Apply discount code to subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-apply-discount","href":"/subscription-admin-api/subscription-contracts/apply-discount-code-to-subscription"},{"title":"Replace all line item attributes in bulk across subscription contracts","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-bulk-update-line-item-attributes","href":"/subscription-admin-api/subscription-contracts/replace-all-line-item-attributes-in-bulk-across-subscription-contracts"},{"title":"Send magic link email to customer for portal access","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contracts-email-magic-link","href":"/subscription-admin-api/subscription-contracts/send-magic-link-email-to-customer-for-portal-access"},{"title":"Remove discount from subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-remove-discount","href":"/subscription-admin-api/subscription-contracts/remove-discount-from-subscription"},{"title":"Update next billing date for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-billing-date","href":"/subscription-admin-api/subscription-contracts/update-next-billing-date-for-a-subscription-contract"},{"title":"Update billing interval for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-billing-interval","href":"/subscription-admin-api/subscription-contracts/update-billing-interval-for-a-subscription-contract"},{"title":"Update Subscription contract frequency by compatible selling-plan frequency","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-frequency-by-compatible-plan","href":"/subscription-admin-api/subscription-contracts/update-subscription-contract-frequency-by-compatible-selling-plan-frequency"},{"title":"Update Subscription contract frequency by selling plan","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-frequency-by-selling-plan","href":"/subscription-admin-api/subscription-contracts/update-subscription-contract-frequency-by-selling-plan"},{"title":"Update line item attributes for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-attributes","href":"/subscription-admin-api/subscription-contracts/update-line-item-attributes-for-a-subscription-contract"},{"title":"Update multiple line item attributes for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-multiple-line-item-attributes","href":"/subscription-admin-api/subscription-contracts/update-multiple-line-item-attributes-for-a-subscription-contract"},{"title":"Cancel a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json delete /api/external/v2/subscription-contracts/{id}","href":"/subscription-admin-api/subscription-contracts/cancel-a-subscription-contract"}]},{"group":"Build-a-Box \u0026 Bundles","pages":[{"title":"Update an existing Build-A-Box subscription bundle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/build-a-box","href":"/subscription-admin-api/build-a-box-\u0026-bundles/update-an-existing-build-a-box-subscription-bundle"},{"title":"Create a new Build-A-Box subscription bundle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/build-a-box","href":"/subscription-admin-api/build-a-box-\u0026-bundles/create-a-new-build-a-box-subscription-bundle"},{"title":"Retrieve Build-A-Box bundle details by handle for customer storefront","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/build-a-box/{handle}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/retrieve-build-a-box-bundle-details-by-handle-for-customer-storefront"},{"title":"Retrieve a Build-A-Box bundle by ID","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/build-a-box/{id}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/retrieve-a-build-a-box-bundle-by-id"},{"title":"Delete a Build-A-Box subscription bundle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json delete /api/external/v2/build-a-box/{id}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/delete-a-build-a-box-subscription-bundle"},{"title":"Get subscription bundle settings (Build-a-Box configuration)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-bundle-settings/{id}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/get-subscription-bundle-settings-build-a-box-configuration"},{"title":"Update subscription bundling configuration","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-bundling/update","href":"/subscription-admin-api/build-a-box-\u0026-bundles/update-subscription-bundling-configuration"},{"title":"Generate discount code for bundle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-bundlings/discount/{token}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/generate-discount-code-for-bundle"},{"title":"Get bundle details by handle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-bundlings/external/get-bundle/{handle}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/get-bundle-details-by-handle"}]},{"group":"Customization","pages":[{"title":"Get customer portal settings","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/customer-portal-settings/{id}","href":"/subscription-admin-api/customization/get-customer-portal-settings"},{"title":"Get custom CSS for customer portal","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-custom-csses/{id}","href":"/subscription-admin-api/customization/get-custom-css-for-customer-portal"},{"title":"Regenerate subscription widget scripts","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/theme-settings/regenerate-scripts-for-shop","href":"/subscription-admin-api/customization/regenerate-subscription-widget-scripts"}]},{"group":"Customer Retention","pages":[{"title":"Get customer retention activities","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/customer-retention-activities","href":"/subscription-admin-api/customer-retention/get-customer-retention-activities"}]},{"group":"Subscription Data","pages":[{"title":"Get delivery options for subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/data/contract-delivery-options","href":"/subscription-admin-api/subscription-data/get-delivery-options-for-subscription-contract"}]},{"group":"Customers","pages":[{"title":"Generate customer portal access link by customer ID or email","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/manage-subscription-link","href":"/subscription-admin-api/customers/generate-customer-portal-access-link-by-customer-id-or-email"},{"title":"Generate customer portal link","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/manage-subscription-link/{customerId}","href":"/subscription-admin-api/customers/generate-customer-portal-link"},{"title":"Retrieve customers with subscriptions","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/customers","href":"/subscription-admin-api/customers/retrieve-customers-with-subscriptions"},{"title":"Get customer payment methods from Shopify","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/shopify/customer/{customerId}/payment-methods","href":"/subscription-admin-api/customers/get-customer-payment-methods-from-shopify"},{"title":"Get detailed subscription information for a customer","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-customers-detail/valid/{customerId}","href":"/subscription-admin-api/customers/get-detailed-subscription-information-for-a-customer"},{"title":"Sync customer subscription details from Shopify","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-customers/sync-info/{customerId}","href":"/subscription-admin-api/customers/sync-customer-subscription-details-from-shopify"},{"title":"Get valid subscription contract IDs for a customer","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-customers/valid/{customerId}","href":"/subscription-admin-api/customers/get-valid-subscription-contract-ids-for-a-customer"},{"title":"Get customer details with subscriptions","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-customers/{id}","href":"/subscription-admin-api/customers/get-customer-details-with-subscriptions"}]},{"group":"Product Catalog","pages":[{"title":"Get all product swaps for a shop","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/product-swaps","href":"/subscription-admin-api/product-catalog/get-all-product-swaps-for-a-shop"},{"title":"Update an existing product swap automation","deprecated":true,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/product-swaps","href":"/subscription-admin-api/product-catalog/update-an-existing-product-swap-automation"},{"title":"Create a new product swap automation","deprecated":true,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/product-swaps","href":"/subscription-admin-api/product-catalog/create-a-new-product-swap-automation"},{"title":"Get product swap variant groups for a contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/product-swaps-by-variant-groups/{contractId}","href":"/subscription-admin-api/product-catalog/get-product-swap-variant-groups-for-a-contract"},{"title":"Get a specific product swap by ID","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/product-swaps/{id}","href":"/subscription-admin-api/product-catalog/get-a-specific-product-swap-by-id"},{"title":"Delete a product swap automation","deprecated":true,"version":null,"openapi":"/subscription/admin-api-swagger.json delete /api/external/v2/product-swaps/{id}","href":"/subscription-admin-api/product-catalog/delete-a-product-swap-automation"}]},{"group":"Subscription Management","pages":[{"title":"List quick checkout links","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/quick-checkout/links","href":"/subscription-admin-api/subscription-management/list-quick-checkout-links"},{"title":"Get subscription contract analytics and revenue metrics","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/analytics/{contractId}","href":"/subscription-admin-api/subscription-management/get-subscription-contract-analytics-and-revenue-metrics"},{"title":"Get available billing intervals for selling plan(s)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/billing-interval","href":"/subscription-admin-api/subscription-management/get-available-billing-intervals-for-selling-plans"},{"title":"Create a new subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-contract-details/create-subscription-contract","href":"/subscription-admin-api/subscription-management/create-a-new-subscription-contract"},{"title":"Get current billing cycle number for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/current-cycle/{contractId}","href":"/subscription-admin-api/subscription-management/get-current-billing-cycle-number-for-a-subscription-contract"},{"title":"Replace product variants in a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-contract-details/replace-variants-v3","href":"/subscription-admin-api/subscription-management/replace-product-variants-in-a-subscription-contract"},{"title":"Split or duplicate an existing subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-contract-details/split-existing-contract","href":"/subscription-admin-api/subscription-management/split-or-duplicate-an-existing-subscription-contract"},{"title":"Get subscription fulfillment details for latest order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/subscription-fulfillments/{contractId}","href":"/subscription-admin-api/subscription-management/get-subscription-fulfillment-details-for-latest-order"},{"title":"Update delivery interval for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-delivery-interval","href":"/subscription-admin-api/subscription-management/update-delivery-interval-for-a-subscription-contract"},{"title":"Update subscription delivery method","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-delivery-method","href":"/subscription-admin-api/subscription-management/update-subscription-delivery-method"},{"title":"Update delivery price for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-delivery-price","href":"/subscription-admin-api/subscription-management/update-delivery-price-for-a-subscription-contract"},{"title":"Turn custom delivery price on or off for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-delivery-price-override","href":"/subscription-admin-api/subscription-management/turn-custom-delivery-price-on-or-off-for-a-subscription-contract"},{"title":"Update maximum cycles for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-max-cycles","href":"/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract"},{"title":"Update minimum cycles for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-min-cycles","href":"/subscription-admin-api/subscription-management/update-minimum-cycles-for-a-subscription-contract"},{"title":"Update order note for subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-order-note/{contractId}","href":"/subscription-admin-api/subscription-management/update-order-note-for-subscription"},{"title":"Update subscription delivery address and method","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-shipping-address","href":"/subscription-admin-api/subscription-management/update-subscription-delivery-address-and-method"},{"title":"Update subscription contract status","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-status","href":"/subscription-admin-api/subscription-management/update-subscription-contract-status"},{"title":"Get raw Shopify GraphQL contract response","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contracts/contract-external/{contractId}","href":"/subscription-admin-api/subscription-management/get-raw-shopify-graphql-contract-response"},{"title":"Update custom attributes on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/update-custom-note-attributes","href":"/subscription-admin-api/subscription-management/update-custom-attributes-on-a-subscription-contract"}]},{"group":"Billing \u0026 Payments","pages":[{"title":"Update subscription billing attempt","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts","href":"/subscription-admin-api/billing-\u0026-payments/update-subscription-billing-attempt"},{"title":"Update order note for a billing attempt","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts-update-order-note/{id}","href":"/subscription-admin-api/billing-\u0026-payments/update-order-note-for-a-billing-attempt"},{"title":"Trigger immediate billing for an order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/attempt-billing/{id}","href":"/subscription-admin-api/billing-\u0026-payments/trigger-immediate-billing-for-an-order"},{"title":"Get past orders","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-billing-attempts/past-orders","href":"/subscription-admin-api/billing-\u0026-payments/get-past-orders"},{"title":"Get past orders report with detailed filtering","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-billing-attempts/past-orders/report","href":"/subscription-admin-api/billing-\u0026-payments/get-past-orders-report-with-detailed-filtering"},{"title":"Reschedule a billing attempt to a new date","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/reschedule-order/{id}","href":"/subscription-admin-api/billing-\u0026-payments/reschedule-a-billing-attempt-to-a-new-date"},{"title":"Skip a specific order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/skip-order/{id}","href":"/subscription-admin-api/billing-\u0026-payments/skip-a-specific-order"},{"title":"Skip the next upcoming order for a subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/skip-upcoming-order","href":"/subscription-admin-api/billing-\u0026-payments/skip-the-next-upcoming-order-for-a-subscription"},{"title":"Get upcoming orders (top orders)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-billing-attempts/top-orders","href":"/subscription-admin-api/billing-\u0026-payments/get-upcoming-orders-top-orders"},{"title":"Unskip a previously skipped order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/unskip-order/{id}","href":"/subscription-admin-api/billing-\u0026-payments/unskip-a-previously-skipped-order"}]},{"group":"Subscription Products","pages":[{"title":"Add product with custom price to subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contract-add-line-item","href":"/subscription-admin-api/subscription-products/add-product-with-custom-price-to-subscription"},{"title":"Add product to subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-add-line-item","href":"/subscription-admin-api/subscription-products/add-product-to-subscription"},{"title":"Add multiple products to subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-add-line-items","href":"/subscription-admin-api/subscription-products/add-multiple-products-to-subscription"},{"title":"Remove product from subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-remove-line-item","href":"/subscription-admin-api/subscription-products/remove-product-from-subscription"},{"title":"Remove multiple products from subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-remove-line-items","href":"/subscription-admin-api/subscription-products/remove-multiple-products-from-subscription"},{"title":"Update multiple properties of a subscription line item","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item","href":"/subscription-admin-api/subscription-products/update-multiple-properties-of-a-subscription-line-item"},{"title":"Update product line item price","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-price","href":"/subscription-admin-api/subscription-products/update-product-line-item-price"},{"title":"Update line item pricing policy with cycle-based discounts","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-pricing-policy","href":"/subscription-admin-api/subscription-products/update-line-item-pricing-policy-with-cycle-based-discounts"},{"title":"Update product line item quantity in subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-quantity","href":"/subscription-admin-api/subscription-products/update-product-line-item-quantity-in-subscription"},{"title":"Update selling plan for a subscription line item","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-selling-plan","href":"/subscription-admin-api/subscription-products/update-selling-plan-for-a-subscription-line-item"}]},{"group":"Subscription One-Time Products","pages":[{"title":"Get all one-time products for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-one-offs-by-contractId","href":"/subscription-admin-api/subscription-one-time-products/get-all-one-time-products-for-a-subscription-contract"},{"title":"Add one-time product to subscription order","deprecated":true,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/subscription-admin-api/subscription-one-time-products/add-one-time-product-to-subscription-order"},{"title":"Remove one-time product from subscription order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json delete /api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/subscription-admin-api/subscription-one-time-products/remove-one-time-product-from-subscription-order"},{"title":"Get one-time products for next upcoming order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/upcoming-subscription-contract-one-offs-by-contractId","href":"/subscription-admin-api/subscription-one-time-products/get-one-time-products-for-next-upcoming-order"}]},{"group":"Subscription Payments","pages":[{"title":"Update subscription payment method","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-existing-payment-method","href":"/subscription-admin-api/subscription-payments/update-subscription-payment-method"},{"title":"Send payment method update email to customer","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-payment-method","href":"/subscription-admin-api/subscription-payments/send-payment-method-update-email-to-customer"}]},{"group":"Subscription Plans","pages":[{"title":"Get all subscription groups","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-groups","href":"/subscription-admin-api/subscription-plans/get-all-subscription-groups"},{"title":"Update subscription group details and product assignments","description":"Updates an existing subscription group (selling plan group) including its name, selling plans configuration, and optionally manages product/variant assignments. This endpoint provides comprehensive update capabilities for both the subscription group structure and its product associations.\n\n**Key Capabilities:**\n- Update subscription group name\n- Modify existing selling plan configurations (discounts, frequencies, trials, etc.)\n- Add or remove products/variants through updateProducts and deleteProducts fields\n- Cannot add or remove selling plans - only modify existing ones\n- Automatically handles complex discount transitions for free trials and prepaid plans\n- Updates delivery profile associations if changed\n- Triggers asynchronous operations for metafield updates and free product checks\n\n**Important Notes:**\n- The 'id' field is required and must match an existing subscription group\n- For each selling plan in subscriptionPlans array, provide 'idNew' with the existing selling plan ID\n- Plan modifications maintain the same selling plan ID in Shopify\n- Product/variant updates are processed after group details are updated\n- Large product updates (allProduct=true) run asynchronously\n\n**Selling Plan Updates:**\n- Can change discount amounts, types, and cycles\n- Can modify billing/delivery frequencies\n- Can add/remove free trials\n- Can change member restrictions and tags\n- Can update specific day delivery settings\n- Can modify min/max cycles\n\n**Authentication:** Requires valid X-API-Key header","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-groups","href":"/subscription-admin-api/subscription-plans/update-subscription-group-details-and-product-assignments"},{"title":"Create a new subscription group (selling plan group)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-groups","href":"/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group"},{"title":"Get all selling plans across all subscription groups","description":"Retrieves a flattened list of all selling plans from all subscription groups in the store. This endpoint provides a consolidated view of every subscription plan available, regardless of which group it belongs to.\n\n**Response includes:**\n- All selling plans with their configurations\n- Group information for each plan (groupId and groupName)\n- Complete discount and pricing details\n- Delivery and billing frequencies\n- Member restrictions and settings\n- Free trial configurations\n\n**Use Cases:**\n- Build a unified subscription selector\n- Compare all available subscription options\n- Analyze pricing across all plans\n- Find specific plan configurations\n- Generate reports on subscription offerings\n\n**Differences from /subscription-groups endpoint:**\n- Returns plans as a flat list, not grouped\n- Each plan includes its parent group information\n- Easier to search/filter across all plans\n- Does not include product/variant assignments\n\n**Authentication:** Requires valid X-API-Key header","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-groups/all-selling-plans","href":"/subscription-admin-api/subscription-plans/get-all-selling-plans-across-all-subscription-groups"},{"title":"Remove products or variants from ALL subscription groups","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-groups/remove-products","href":"/subscription-admin-api/subscription-plans/remove-products-or-variants-from-all-subscription-groups"},{"title":"Add products or variants to an existing subscription group (async)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-groups/v3/{id}/add-products","href":"/subscription-admin-api/subscription-plans/add-products-or-variants-to-an-existing-subscription-group-async"},{"title":"Check status of an async add-products job","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-groups/v3/{id}/add-products/status","href":"/subscription-admin-api/subscription-plans/check-status-of-an-async-add-products-job"},{"title":"Get subscription group by ID","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-groups/{id}","href":"/subscription-admin-api/subscription-plans/get-subscription-group-by-id"},{"title":"Add products or variants to an existing subscription group","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-groups/{id}/add-products","href":"/subscription-admin-api/subscription-plans/add-products-or-variants-to-an-existing-subscription-group"},{"title":"Bulk add products or variants to an existing subscription group","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-groups/{id}/bulk-add-products","href":"/subscription-admin-api/subscription-plans/bulk-add-products-or-variants-to-an-existing-subscription-group"},{"title":"Remove products or variants from a subscription group","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-groups/{id}/remove-products","href":"/subscription-admin-api/subscription-plans/remove-products-or-variants-from-a-subscription-group"}]}]},{"group":"Storefront API","pages":[{"group":"Billing \u0026 Payments","pages":[{"title":"Get backup payment recovery opt-in status","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/backup-payment-opt-in","href":"/subscription-storefront-api/billing-\u0026-payments/get-backup-payment-recovery-opt-in-status"},{"title":"Update backup payment recovery opt-in status","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/backup-payment-opt-in","href":"/subscription-storefront-api/billing-\u0026-payments/update-backup-payment-recovery-opt-in-status"},{"title":"Update subscription billing attempt","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts","href":"/subscription-storefront-api/billing-\u0026-payments/update-subscription-billing-attempt"},{"title":"Trigger immediate billing for an order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/attempt-billing/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/trigger-immediate-billing-for-an-order"},{"title":"Recover a billing attempt stuck in progress","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/fix-billing-attempt-in-progress/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/recover-a-billing-attempt-stuck-in-progress"},{"title":"Get past orders","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-billing-attempts/past-orders","href":"/subscription-storefront-api/billing-\u0026-payments/get-past-orders"},{"title":"Get past orders report with detailed filtering","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-billing-attempts/past-orders/report","href":"/subscription-storefront-api/billing-\u0026-payments/get-past-orders-report-with-detailed-filtering"},{"title":"Process refund for subscription order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/refund-fulfillment/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/process-refund-for-subscription-order"},{"title":"Calculate refund amount preview","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/calculate-refund-amount-preview"},{"title":"Reschedule a billing attempt to a new date","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/reschedule-order/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/reschedule-a-billing-attempt-to-a-new-date"},{"title":"Retry a failed billing attempt","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/retry-failed-billing-attempt","href":"/subscription-storefront-api/billing-\u0026-payments/retry-a-failed-billing-attempt"},{"title":"Get URL for 3DS / SCA security challenge","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-billing-attempts/security-challenge-action-url/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/get-url-for-3ds-sca-security-challenge"},{"title":"Skip a failed billing attempt's order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/skip-failed-order","href":"/subscription-storefront-api/billing-\u0026-payments/skip-a-failed-billing-attempts-order"},{"title":"Skip a specific order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/skip-order/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/skip-a-specific-order"},{"title":"Skip the next upcoming order for a subscription","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/skip-upcoming-order","href":"/subscription-storefront-api/billing-\u0026-payments/skip-the-next-upcoming-order-for-a-subscription"},{"title":"Get upcoming orders (top orders)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-billing-attempts/top-orders","href":"/subscription-storefront-api/billing-\u0026-payments/get-upcoming-orders-top-orders"},{"title":"Unskip a previously skipped order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/unskip-order/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/unskip-a-previously-skipped-order"},{"title":"Get subscription payment info for a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-payment-infos/{contractId}","href":"/subscription-storefront-api/billing-\u0026-payments/get-subscription-payment-info-for-a-contract"}]},{"group":"Product Catalog","pages":[{"title":"List discount rules applicable to bundles","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/bundle-discount-rules","href":"/subscription-storefront-api/product-catalog/list-discount-rules-applicable-to-bundles"},{"title":"Get variant data for a list of variant IDs","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/product-infos/variant-data/{variantIds}","href":"/subscription-storefront-api/product-catalog/get-variant-data-for-a-list-of-variant-ids"},{"title":"Get product swap variant groups for a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/product-swaps-by-variant-groups/{contractId}","href":"/subscription-storefront-api/product-catalog/get-product-swap-variant-groups-for-a-contract"},{"title":"Proxy a Shopify Storefront GraphQL request from the customer portal","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/storefront-graphql","href":"/subscription-storefront-api/product-catalog/proxy-a-shopify-storefront-graphql-request-from-the-customer-portal"}]},{"group":"Campaigns","pages":[{"title":"List applicable customer portal campaigns","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/campaigns/applicable","href":"/subscription-storefront-api/campaigns/list-applicable-customer-portal-campaigns"},{"title":"List applicable customer portal campaigns for multiple contracts in one call","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/campaigns/applicable-bulk","href":"/subscription-storefront-api/campaigns/list-applicable-customer-portal-campaigns-for-multiple-contracts-in-one-call"},{"title":"Get campaign landing details","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/campaigns/{id}/landing","href":"/subscription-storefront-api/campaigns/get-campaign-landing-details"},{"title":"Redeem a campaign offer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/campaigns/{id}/redeem","href":"/subscription-storefront-api/campaigns/redeem-a-campaign-offer"},{"title":"Track a campaign banner event","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/campaigns/{id}/track","href":"/subscription-storefront-api/campaigns/track-a-campaign-banner-event"}]},{"group":"cancellation-flow-customer-portal-resource","pages":[{"title":"Get subscriptionscpapicancellation flowspublished","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/cancellation-flows/published","href":"/subscription-storefront-api/cancellation-flow-customer-portal-resource/get-subscriptionscpapicancellation-flowspublished"}]},{"group":"Customer Retention","pages":[{"title":"Get cancellation management configuration","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/cancellation-managements/{id}","href":"/subscription-storefront-api/customer-retention/get-cancellation-management-configuration"},{"title":"Record a customer retention activity","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/customer-retention-activities","href":"/subscription-storefront-api/customer-retention/record-a-customer-retention-activity"},{"title":"Get subscriptionscpapicustomer retention activitieslatest discount usage","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-retention-activities/latest-discount-usage","href":"/subscription-storefront-api/customer-retention/get-subscriptionscpapicustomer-retention-activitieslatest-discount-usage"},{"title":"Get win-back offer landing details","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/win-back-campaigns/{id}/landing","href":"/subscription-storefront-api/customer-retention/get-win-back-offer-landing-details"},{"title":"Reactivate a subscription from a win-back offer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/win-back-campaigns/{id}/reactivate","href":"/subscription-storefront-api/customer-retention/reactivate-a-subscription-from-a-win-back-offer"}]},{"group":"Subscription Contracts","pages":[{"title":"Execute a configured cancellation retention offer and record the retention activity","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/cancellation-retention-offers/execute","href":"/subscription-storefront-api/subscription-contracts/execute-a-configured-cancellation-retention-offer-and-record-the-retention-activity"},{"title":"Get currently logged-in customer ID","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/logged-in-customer","href":"/subscription-storefront-api/subscription-contracts/get-currently-logged-in-customer-id"},{"title":"Skip or unskip a product line item for next order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/skip-unskip-subscription-contracts-product","href":"/subscription-storefront-api/subscription-contracts/skip-or-unskip-a-product-line-item-for-next-order"},{"title":"Update subscription contract details","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contract-details","href":"/subscription-storefront-api/subscription-contracts/update-subscription-contract-details"},{"title":"Get current billing cycle for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-details/current-cycle/{contractId}","href":"/subscription-storefront-api/subscription-contracts/get-current-billing-cycle-for-a-subscription-contract"},{"title":"Get order note for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-details/customer/{contractId}","href":"/subscription-storefront-api/subscription-contracts/get-order-note-for-a-subscription-contract"},{"title":"Merge an existing contract into another","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/merge-contract","href":"/subscription-storefront-api/subscription-contracts/merge-an-existing-contract-into-another"},{"title":"Replace contract variants in bulk (v2)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/replace-variants-v2","href":"/subscription-storefront-api/subscription-contracts/replace-contract-variants-in-bulk-v2"},{"title":"Get current customer's saved Shopify payment methods","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-details/shopify/customer/payment-methods","href":"/subscription-storefront-api/subscription-contracts/get-current-customers-saved-shopify-payment-methods"},{"title":"Reschedule a planned subscription fulfillment","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contract-details/subscription-fulfillment/reschedule","href":"/subscription-storefront-api/subscription-contracts/reschedule-a-planned-subscription-fulfillment"},{"title":"List Shopify fulfillments for a specific order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-details/subscription-fulfillments/order/{orderId}","href":"/subscription-storefront-api/subscription-contracts/list-shopify-fulfillments-for-a-specific-order"},{"title":"List Shopify fulfillments for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-details/subscription-fulfillments/{contractId}","href":"/subscription-storefront-api/subscription-contracts/list-shopify-fulfillments-for-a-subscription-contract"},{"title":"Swap a product within a Build-a-Box subscription","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contract-details/swap-bab-product","href":"/subscription-storefront-api/subscription-contracts/swap-a-product-within-a-build-a-box-subscription"},{"title":"Get subscription contract as a flattened map","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-raw/{contractId}","href":"/subscription-storefront-api/subscription-contracts/get-subscription-contract-as-a-flattened-map"},{"title":"Apply a discount code to a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-apply-discount","href":"/subscription-storefront-api/subscription-contracts/apply-a-discount-code-to-a-subscription-contract"},{"title":"Apply a cancellation-flow discount to a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-cancellation-discount","href":"/subscription-storefront-api/subscription-contracts/apply-a-cancellation-flow-discount-to-a-contract"},{"title":"Edit custom attributes on a single line item","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-edit-line-item-attributes","href":"/subscription-storefront-api/subscription-contracts/edit-custom-attributes-on-a-single-line-item"},{"title":"Email customer portal magic link to subscriber","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts-email-magic-link","href":"/subscription-storefront-api/subscription-contracts/email-customer-portal-magic-link-to-subscriber"},{"title":"Read freeze (skip-billing) status of a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts-freeze-status-detail","href":"/subscription-storefront-api/subscription-contracts/read-freeze-skip-billing-status-of-a-contract"},{"title":"Read freeze (skip-billing) status of a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-freeze-status-detail","href":"/subscription-storefront-api/subscription-contracts/read-freeze-skip-billing-status-of-a-contract-1"},{"title":"Check whether anchor day overwrite is enabled","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts-is-overwrite-anchor-day","href":"/subscription-storefront-api/subscription-contracts/check-whether-anchor-day-overwrite-is-enabled"},{"title":"Update product-level custom attributes on a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-product-custom-attributes","href":"/subscription-storefront-api/subscription-contracts/update-product-level-custom-attributes-on-a-contract"},{"title":"Remove a discount from a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-remove-discount","href":"/subscription-storefront-api/subscription-contracts/remove-a-discount-from-a-subscription-contract"},{"title":"Remove a line item from a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-remove-line-item","href":"/subscription-storefront-api/subscription-contracts/remove-a-line-item-from-a-subscription-contract"},{"title":"Update next billing date for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-billing-date","href":"/subscription-storefront-api/subscription-contracts/update-next-billing-date-for-a-subscription-contract"},{"title":"Update billing interval for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-billing-interval","href":"/subscription-storefront-api/subscription-contracts/update-billing-interval-for-a-subscription-contract"},{"title":"Update delivery method on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-delivery-method","href":"/subscription-storefront-api/subscription-contracts/update-delivery-method-on-a-subscription-contract"},{"title":"Set existing Shopify payment method on contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-existing-payment-method","href":"/subscription-storefront-api/subscription-contracts/set-existing-shopify-payment-method-on-contract"},{"title":"Change contract frequency by selecting a compatible selling-plan frequency","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-frequency-by-compatible-plan","href":"/subscription-storefront-api/subscription-contracts/change-contract-frequency-by-selecting-a-compatible-selling-plan-frequency"},{"title":"Change contract frequency by selecting a new selling plan","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-frequency-by-selling-plan","href":"/subscription-storefront-api/subscription-contracts/change-contract-frequency-by-selecting-a-new-selling-plan"},{"title":"Update custom attributes on contract line items","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-line-item-attributes","href":"/subscription-storefront-api/subscription-contracts/update-custom-attributes-on-contract-line-items"},{"title":"Update line item quantity on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-line-item-quantity","href":"/subscription-storefront-api/subscription-contracts/update-line-item-quantity-on-a-subscription-contract"},{"title":"Update order note on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-order-note/{contractId}","href":"/subscription-storefront-api/subscription-contracts/update-order-note-on-a-subscription-contract"},{"title":"Trigger payment method re-collection email","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-payment-method","href":"/subscription-storefront-api/subscription-contracts/trigger-payment-method-re-collection-email"},{"title":"Get raw Shopify subscription contracts for multiple contracts in one call","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts/contract-external-bulk","href":"/subscription-storefront-api/subscription-contracts/get-raw-shopify-subscription-contracts-for-multiple-contracts-in-one-call"},{"title":"Get raw Shopify subscription contract (external view)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts/contract-external/{contractId}","href":"/subscription-storefront-api/subscription-contracts/get-raw-shopify-subscription-contract-external-view"},{"title":"Get raw Shopify subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts/contract/{contractId}","href":"/subscription-storefront-api/subscription-contracts/get-raw-shopify-subscription-contract"},{"title":"Sync shipping price on contract from delivery profile","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts/sync-shipping-price/{contractId}","href":"/subscription-storefront-api/subscription-contracts/sync-shipping-price-on-contract-from-delivery-profile"},{"title":"Cancel and delete a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json delete /subscriptions/cp/api/subscription-contracts/{id}","href":"/subscription-storefront-api/subscription-contracts/cancel-and-delete-a-subscription-contract"},{"title":"Get current customer's subscription profile","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-customers","href":"/subscription-storefront-api/subscription-contracts/get-current-customers-subscription-profile"},{"title":"Get valid subscription contracts for a customer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-customers-detail/valid/{id}","href":"/subscription-storefront-api/subscription-contracts/get-valid-subscription-contracts-for-a-customer"},{"title":"List a customer's valid subscription contract IDs","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-customers/valid/{id}","href":"/subscription-storefront-api/subscription-contracts/list-a-customers-valid-subscription-contract-ids"},{"title":"Update line item quantities for a classic Build-a-Box subscription","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/update-classic-bab-subscription/{contractId}","href":"/subscription-storefront-api/subscription-contracts/update-line-item-quantities-for-a-classic-build-a-box-subscription"},{"title":"Update subscription contract order note","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/update-contract-order-note/{contractId}","href":"/subscription-storefront-api/subscription-contracts/update-subscription-contract-order-note"},{"title":"Add a fixed pricing bundle line item, with its child products, to a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/v2/subscription-contracts-add-bundle-line-item","href":"/subscription-storefront-api/subscription-contracts/add-a-fixed-pricing-bundle-line-item-with-its-child-products-to-a-subscription-contract"},{"title":"Add a line item to a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/v2/subscription-contracts-add-line-item","href":"/subscription-storefront-api/subscription-contracts/add-a-line-item-to-a-subscription-contract"},{"title":"Add a line item to a specific section of a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/v2/subscription-contracts-add-sectioned-line-item/{contractId}","href":"/subscription-storefront-api/subscription-contracts/add-a-line-item-to-a-specific-section-of-a-contract"}]},{"group":"Customer Portal","pages":[{"title":"Proxy GraphQL queries to Shopify Customer Account API","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/customer-account-api/graphql","href":"/subscription-storefront-api/customer-portal/proxy-graphql-queries-to-shopify-customer-account-api"},{"title":"Initiate Customer Account API OAuth flow","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/customer-account-api/initiate","href":"/subscription-storefront-api/customer-portal/initiate-customer-account-api-oauth-flow"},{"title":"Logout from Customer Account API","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-account-api/logout","href":"/subscription-storefront-api/customer-portal/logout-from-customer-account-api"},{"title":"Handle OAuth callback from Shopify","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-account-api/oauth/callback","href":"/subscription-storefront-api/customer-portal/handle-oauth-callback-from-shopify"},{"title":"Check Customer Account API authentication status","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-account-api/status","href":"/subscription-storefront-api/customer-portal/check-customer-account-api-authentication-status"},{"title":"Get shop info for the currently signed-in shop","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/shop-infos-by-current-login","href":"/subscription-storefront-api/customer-portal/get-shop-info-for-the-currently-signed-in-shop"}]},{"group":"Customization","pages":[{"title":"Get customer portal settings","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-portal-settings/{id}","href":"/subscription-storefront-api/customization/get-customer-portal-settings"},{"title":"Get customer portal label translations for locale","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/label-translations/locale","href":"/subscription-storefront-api/customization/get-customer-portal-label-translations-for-locale"},{"title":"Get shop customization CSS by category","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/shop-customizations/css/{category}","href":"/subscription-storefront-api/customization/get-shop-customization-css-by-category"},{"title":"Get custom CSS for customer portal","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-custom-csses/{id}","href":"/subscription-storefront-api/customization/get-custom-css-for-customer-portal"},{"title":"Get widget label translations for locale","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/widget-label-translations/locale","href":"/subscription-storefront-api/customization/get-widget-label-translations-for-locale"}]},{"group":"Subscription Data","pages":[{"title":"Get delivery options for subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/contract-delivery-options","href":"/subscription-storefront-api/subscription-data/get-delivery-options-for-subscription-contract"},{"title":"List live carrier-quoted shipping rates for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/contract-live-shipping-rates","href":"/subscription-storefront-api/subscription-data/list-live-carrier-quoted-shipping-rates-for-a-subscription-contract"},{"title":"Get single product data by ID","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/product","href":"/subscription-storefront-api/subscription-data/get-single-product-data-by-id"},{"title":"List product handles for the shop","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/product-handles","href":"/subscription-storefront-api/subscription-data/list-product-handles-for-the-shop"},{"title":"Get products data with pagination","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/products","href":"/subscription-storefront-api/subscription-data/get-products-data-with-pagination"},{"title":"Get selling plans for products","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/products-selling-plans","href":"/subscription-storefront-api/subscription-data/get-selling-plans-for-products"},{"title":"Search subscription-enabled products with pagination","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/products1","href":"/subscription-storefront-api/subscription-data/search-subscription-enabled-products-with-pagination"},{"title":"List subscription products filtered by selling plans","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/selling-plan-products","href":"/subscription-storefront-api/subscription-data/list-subscription-products-filtered-by-selling-plans"},{"title":"List delivery options available for the shop","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/shop-delivery-options","href":"/subscription-storefront-api/subscription-data/list-delivery-options-available-for-the-shop"},{"title":"List subscription products available to the customer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/subscription-products","href":"/subscription-storefront-api/subscription-data/list-subscription-products-available-to-the-customer"},{"title":"Get compatible selling-plan frequencies","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/v2/compatible-selling-plan-frequencies","href":"/subscription-storefront-api/subscription-data/get-compatible-selling-plan-frequencies"},{"title":"List products with their selling plans (v2)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/v2/products-selling-plans","href":"/subscription-storefront-api/subscription-data/list-products-with-their-selling-plans-v2"},{"title":"Get variant contextual pricing","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/variant-contextual-pricing","href":"/subscription-storefront-api/subscription-data/get-variant-contextual-pricing"},{"title":"List saved addresses for the current customer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/v2/data/addresses","href":"/subscription-storefront-api/subscription-data/list-saved-addresses-for-the-current-customer"},{"title":"List supported shipping countries","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/v2/data/countries","href":"/subscription-storefront-api/subscription-data/list-supported-shipping-countries"},{"title":"List enabled presentment currencies for the shop","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/v2/data/currencies","href":"/subscription-storefront-api/subscription-data/list-enabled-presentment-currencies-for-the-shop"}]},{"group":"Delivery \u0026 Shipping","pages":[{"title":"List delivery profile locations","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/delivery-profiles/get-locations","href":"/subscription-storefront-api/delivery-\u0026-shipping/list-delivery-profile-locations"},{"title":"Get a page of order events (paginated)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/orders/{orderId}/events","href":"/subscription-storefront-api/delivery-\u0026-shipping/get-a-page-of-order-events-paginated"},{"title":"Get the live fulfillment status for an order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/orders/{orderId}/live-status","href":"/subscription-storefront-api/delivery-\u0026-shipping/get-the-live-fulfillment-status-for-an-order"}]},{"group":"Loyalty Integration","pages":[{"title":"Get customer loyalty points and rewards data","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/loyalty-integration/customer","href":"/subscription-storefront-api/loyalty-integration/get-customer-loyalty-points-and-rewards-data"},{"title":"Get available ways to earn loyalty points","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/loyalty-integration/earn-options","href":"/subscription-storefront-api/loyalty-integration/get-available-ways-to-earn-loyalty-points"},{"title":"Redeem loyalty points for a reward","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/loyalty-integration/redeem","href":"/subscription-storefront-api/loyalty-integration/redeem-loyalty-points-for-a-reward"},{"title":"Get available loyalty point redemption options","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/loyalty-integration/redeem-options","href":"/subscription-storefront-api/loyalty-integration/get-available-loyalty-point-redemption-options"}]},{"group":"notification-resource","pages":[{"title":"Get subscriptionscpapinotification session","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/notification-session","href":"/subscription-storefront-api/notification-resource/get-subscriptionscpapinotification-session"}]},{"group":"Store Pickup","pages":[{"title":"List eligible pickup dates","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/pickup/eligible-dates","href":"/subscription-storefront-api/store-pickup/list-eligible-pickup-dates"},{"title":"Get the first eligible pickup date","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/pickup/eligible-dates/first","href":"/subscription-storefront-api/store-pickup/get-the-first-eligible-pickup-date"},{"title":"List eligible pickup times for a date","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/pickup/eligible-times","href":"/subscription-storefront-api/store-pickup/list-eligible-pickup-times-for-a-date"},{"title":"List eligible pickup times for a date","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/pickup/eligible-times","href":"/subscription-storefront-api/store-pickup/list-eligible-pickup-times-for-a-date-1"},{"title":"List available pickup locations","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/pickup/locations","href":"/subscription-storefront-api/store-pickup/list-available-pickup-locations"},{"title":"Update pickup and delivery details on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/pickup/subscription-selection","href":"/subscription-storefront-api/store-pickup/update-pickup-and-delivery-details-on-a-subscription-contract"}]},{"group":"Subscription Actions","pages":[{"title":"Execute a server-authoritative next-order delay","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-actions/reschedule-by-days/execute","href":"/subscription-storefront-api/subscription-actions/execute-a-server-authoritative-next-order-delay"},{"title":"Preview a server-authoritative next-order delay","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-actions/reschedule-by-days/preview","href":"/subscription-storefront-api/subscription-actions/preview-a-server-authoritative-next-order-delay"}]},{"group":"Build-a-Box \u0026 Bundles","pages":[{"title":"Get subscription bundle settings by ID","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-bundle-settings/{id}","href":"/subscription-storefront-api/build-a-box-\u0026-bundles/get-subscription-bundle-settings-by-id"},{"title":"Get a subscription bundling configuration by token","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-bundlings/by-token/{token}","href":"/subscription-storefront-api/build-a-box-\u0026-bundles/get-a-subscription-bundling-configuration-by-token"},{"title":"List single-product Build-a-Box bundlings for the shop","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-bundlings/single-product","href":"/subscription-storefront-api/build-a-box-\u0026-bundles/list-single-product-build-a-box-bundlings-for-the-shop"},{"title":"Get public Build-a-Box bundle details by handle (v3)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/v3/subscription-bundlings/external/get-bundle/{handle}","href":"/subscription-storefront-api/build-a-box-\u0026-bundles/get-public-build-a-box-bundle-details-by-handle-v3"}]},{"group":"Subscription Management","pages":[{"title":"Replace product variants in a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/replace-variants-v3","href":"/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract"},{"title":"Split or duplicate an existing subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/split-existing-contract","href":"/subscription-storefront-api/subscription-management/split-or-duplicate-an-existing-subscription-contract"},{"title":"Update subscription delivery address and method","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-shipping-address","href":"/subscription-storefront-api/subscription-management/update-subscription-delivery-address-and-method"},{"title":"Update subscription contract status","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-status","href":"/subscription-storefront-api/subscription-management/update-subscription-contract-status"},{"title":"Update custom attributes on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/update-custom-note-attributes","href":"/subscription-storefront-api/subscription-management/update-custom-attributes-on-a-subscription-contract"}]},{"group":"Subscription Contract Details","pages":[{"title":"Swap a product and change its delivery frequency in one change","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/swap-product-frequency","href":"/subscription-storefront-api/subscription-contract-details/swap-a-product-and-change-its-delivery-frequency-in-one-change"},{"title":"Preview a product swap with its delivery frequency and recurring price","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/swap-product-frequency/preview","href":"/subscription-storefront-api/subscription-contract-details/preview-a-product-swap-with-its-delivery-frequency-and-recurring-price"}]},{"group":"Subscription One-Time Products","pages":[{"title":"List one-time add-on products for a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-one-offs-by-contractId","href":"/subscription-storefront-api/subscription-one-time-products/list-one-time-add-on-products-for-a-contract"},{"title":"Save a one-time add-on for a billing attempt","deprecated":true,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/subscription-storefront-api/subscription-one-time-products/save-a-one-time-add-on-for-a-billing-attempt"},{"title":"Delete a one-time add-on from a billing attempt","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json delete /subscriptions/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/subscription-storefront-api/subscription-one-time-products/delete-a-one-time-add-on-from-a-billing-attempt"},{"title":"Update quantity of a one-time add-on","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contract-one-offs-update-quantity","href":"/subscription-storefront-api/subscription-one-time-products/update-quantity-of-a-one-time-add-on"},{"title":"Get one-time add-ons for the next upcoming order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/upcoming-subscription-contract-one-offs-by-contractId","href":"/subscription-storefront-api/subscription-one-time-products/get-one-time-add-ons-for-the-next-upcoming-order"}]},{"group":"subscription-gift-resource","pages":[{"title":"Get subscriptionscpapisubscription gifts","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-gifts","href":"/subscription-storefront-api/subscription-gift-resource/get-subscriptionscpapisubscription-gifts"}]},{"group":"Subscription Plans","pages":[{"title":"List all selling plans available to the customer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-groups/all-selling-plans","href":"/subscription-storefront-api/subscription-plans/list-all-selling-plans-available-to-the-customer"}]},{"group":"upcoming-order-reward-resource","pages":[{"title":"Get subscriptionscpapiupcoming order rewards","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/upcoming-order-rewards","href":"/subscription-storefront-api/upcoming-order-reward-resource/get-subscriptionscpapiupcoming-order-rewards"}]}]}]},{"tab":"Loyalty","icon":"star","pages":[{"title":"Loyalty","href":"/loyalty/introduction"}]},{"tab":"Memberships","icon":"id-card","pages":[{"title":"Memberships","href":"/memberships/introduction"}]},{"tab":"Bundles","icon":"boxes-stacked","pages":[{"title":"Bundles","href":"/bundles/introduction"}]}]},"basePath":"","title":"Create a new subscription group (selling plan group) - Appstle","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-D6S0Yh6q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}