Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders.
What are Maximum Cycles?
Maximum cycles define subscription duration limits where:
Subscription automatically cancels after the specified number of orders
No further orders are generated once maximum is reached
Useful for fixed-term offers, trials, or seasonal subscriptions
Customer is notified before final order (if configured)
Key Features:
Cannot set below current cycle count (prevents immediate cancellation)
Setting to null creates an indefinite subscription
Automatically reschedules order queue based on new limit
Preserves all other subscription settings
Validates against current subscription progress
Current Cycle Calculation:
Current cycle = Successful billing attempts + 1
Failed payments don’t count toward maximum
First order is cycle 1, second is cycle 2, etc.
System prevents setting max below current position
Common Use Cases:
Trial Subscriptions: ‘3-box trial’ that auto-ends
Seasonal Programs: ‘6-month summer subscription’
Limited Series: ‘12-issue magazine subscription’
Promotional Offers: ‘First 5 boxes at special price’
Gift Subscriptions: Fixed duration gifts that don’t renew
What Happens at Maximum:
When a subscription reaches its maximum cycles:
Maximum Cycles. The total number of orders after which the subscription will automatically terminate. Must be greater than or equal to the current cycle count and any configured minimum cycles. Common values:
{"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":"6af391d29a49dc45d089b234","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-management/update-maximum-cycles-for-a-subscription-contract","slug":"/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract","pageMetadata":{"title":"Update maximum cycles for a subscription contract","description":"Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders.\n\n**What are Maximum Cycles?**\nMaximum cycles define subscription duration limits where:\n- Subscription automatically cancels after the specified number of orders\n- No further orders are generated once maximum is reached\n- Useful for fixed-term offers, trials, or seasonal subscriptions\n- Customer is notified before final order (if configured)\n\n**Key Features:**\n- Cannot set below current cycle count (prevents immediate cancellation)\n- Setting to null creates an indefinite subscription\n- Automatically reschedules order queue based on new limit\n- Preserves all other subscription settings\n- Validates against current subscription progress\n\n**Current Cycle Calculation:**\n- Current cycle = Successful billing attempts + 1\n- Failed payments don't count toward maximum\n- First order is cycle 1, second is cycle 2, etc.\n- System prevents setting max below current position\n\n**Common Use Cases:**\n- **Trial Subscriptions**: '3-box trial' that auto-ends\n- **Seasonal Programs**: '6-month summer subscription'\n- **Limited Series**: '12-issue magazine subscription'\n- **Promotional Offers**: 'First 5 boxes at special price'\n- **Gift Subscriptions**: Fixed duration gifts that don't renew\n\n**What Happens at Maximum:**\nWhen a subscription reaches its maximum cycles:\n1. Final order is processed normally\n2. Subscription status changes to CANCELLED\n3. No future orders are scheduled\n4. Customer receives cancellation notification\n5. Cannot be reactivated (new subscription required)\n\n**Interaction with Min Cycles:**\n- Can have both min and max (e.g., 3 min, 12 max)\n- Min cycles enforces commitment period\n- Max cycles enforces termination\n- Common pattern: Commitment with defined end\n\n**Queue Management:**\nAfter updating max cycles:\n- System recalculates future order schedule\n- Removes orders beyond the new maximum\n- Adjusts upcoming order notifications\n- Updates subscription end date projections\n\n**Important Notes:**\n- Validation prevents accidental immediate cancellation\n- Changes apply to future billing cycles only\n- Activity log tracks old and new values\n- Consider customer communication for changes\n- Setting null removes any duration limit\n\n**Authentication:** Requires valid X-API-Key header","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","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 ol: \"ol\",\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: \"Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"What are Maximum Cycles?\"\n }), \"\\nMaximum cycles define subscription duration limits where:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Subscription automatically cancels after the specified number of orders\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"No further orders are generated once maximum is reached\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Useful for fixed-term offers, trials, or seasonal subscriptions\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Customer is notified before final order (if configured)\"\n }), \"\\n\"]\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: \"Cannot set below current cycle count (prevents immediate cancellation)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Setting to null creates an indefinite subscription\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Automatically reschedules order queue based on new limit\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Preserves all other subscription settings\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Validates against current subscription progress\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Current Cycle Calculation:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Current cycle = Successful billing attempts + 1\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Failed payments don’t count toward maximum\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"First order is cycle 1, second is cycle 2, etc.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"System prevents setting max below current position\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Common Use Cases:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Trial Subscriptions\"\n }), \": ‘3-box trial’ that auto-ends\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Seasonal Programs\"\n }), \": ‘6-month summer subscription’\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Limited Series\"\n }), \": ‘12-issue magazine subscription’\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Promotional Offers\"\n }), \": ‘First 5 boxes at special price’\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Gift Subscriptions\"\n }), \": Fixed duration gifts that don’t renew\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"What Happens at Maximum:\"\n }), \"\\nWhen a subscription reaches its maximum cycles:\"]\n }), \"\\n\", _jsxs(_components.ol, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Final order is processed normally\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Subscription status changes to CANCELLED\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"No future orders are scheduled\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Customer receives cancellation notification\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Cannot be reactivated (new subscription required)\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Interaction with Min Cycles:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Can have both min and max (e.g., 3 min, 12 max)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Min cycles enforces commitment period\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Max cycles enforces termination\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Common pattern: Commitment with defined end\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Queue Management:\"\n }), \"\\nAfter updating max cycles:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"System recalculates future order schedule\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Removes orders beyond the new maximum\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Adjusts upcoming order notifications\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Updates subscription end date projections\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Important Notes:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Validation prevents accidental immediate cancellation\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Changes apply to future billing cycles only\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Activity log tracks old and new values\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Consider customer communication for changes\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Setting null removes any duration limit\"\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":"Update maximum cycles for a subscription contract","description":"Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders.\n\n**What are Maximum Cycles?**\nMaximum cycles define subscription duration limits where:\n- Subscription automatically cancels after the specified number of orders\n- No further orders are generated once maximum is reached\n- Useful for fixed-term offers, trials, or seasonal subscriptions\n- Customer is notified before final order (if configured)\n\n**Key Features:**\n- Cannot set below current cycle count (prevents immediate cancellation)\n- Setting to null creates an indefinite subscription\n- Automatically reschedules order queue based on new limit\n- Preserves all other subscription settings\n- Validates against current subscription progress\n\n**Current Cycle Calculation:**\n- Current cycle = Successful billing attempts + 1\n- Failed payments don't count toward maximum\n- First order is cycle 1, second is cycle 2, etc.\n- System prevents setting max below current position\n\n**Common Use Cases:**\n- **Trial Subscriptions**: '3-box trial' that auto-ends\n- **Seasonal Programs**: '6-month summer subscription'\n- **Limited Series**: '12-issue magazine subscription'\n- **Promotional Offers**: 'First 5 boxes at special price'\n- **Gift Subscriptions**: Fixed duration gifts that don't renew\n\n**What Happens at Maximum:**\nWhen a subscription reaches its maximum cycles:\n1. Final order is processed normally\n2. Subscription status changes to CANCELLED\n3. No future orders are scheduled\n4. Customer receives cancellation notification\n5. Cannot be reactivated (new subscription required)\n\n**Interaction with Min Cycles:**\n- Can have both min and max (e.g., 3 min, 12 max)\n- Min cycles enforces commitment period\n- Max cycles enforces termination\n- Common pattern: Commitment with defined end\n\n**Queue Management:**\nAfter updating max cycles:\n- System recalculates future order schedule\n- Removes orders beyond the new maximum\n- Adjusts upcoming order notifications\n- Updates subscription end date projections\n\n**Important Notes:**\n- Validation prevents accidental immediate cancellation\n- Changes apply to future billing cycles only\n- Activity log tracks old and new values\n- Consider customer communication for changes\n- Setting null removes any duration limit\n\n**Authentication:** Requires valid X-API-Key header","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders.\n\n**What are Maximum Cycles?**\nMaximum cycles define subscription duration limits where:\n- Subscription automatically cancels after the specified number of orders\n- No further orders are generated once maximum is reached\n- Useful for fixed-term offers, trials, or seasonal subscriptions\n- Customer is notified before final order (if configured)\n\n**Key Features:**\n- Cannot set below current cycle count (prevents immediate cancellation)\n- Setting to null creates an indefinite subscription\n- Automatically reschedules order queue based on new limit\n- Preserves all other subscription settings\n- Validates against current subscription progress\n\n**Current Cycle Calculation:**\n- Current cycle = Successful billing attempts + 1\n- Failed payments don't count toward maximum\n- First order is cycle 1, second is cycle 2, etc.\n- System prevents setting max below current position\n\n**Common Use Cases:**\n- **Trial Subscriptions**: '3-box trial' that auto-ends\n- **Seasonal Programs**: '6-month summer subscription'\n- **Limited Series**: '12-issue magazine subscription'\n- **Promotional Offers**: 'First 5 boxes at special price'\n- **Gift Subscriptions**: Fixed duration gifts that don't renew\n\n**What Happens at Maximum:**\nWhen a subscription reaches its maximum cycles:\n1. Final order is processed normally\n2. Subscription status changes to CANCELLED\n3. No future orders are scheduled\n4. Customer receives cancellation notification\n5. Cannot be reactivated (new subscription required)\n\n**Interaction with Min Cycles:**\n- Can have both min and max (e.g., 3 min, 12 max)\n- Min cycles enforces commitment period\n- Max cycles enforces termination\n- Common pattern: Commitment with defined end\n\n**Queue Management:**\nAfter updating max cycles:\n- System recalculates future order schedule\n- Removes orders beyond the new maximum\n- Adjusts upcoming order notifications\n- Updates subscription end date projections\n\n**Important Notes:**\n- Validation prevents accidental immediate cancellation\n- Changes apply to future billing cycles only\n- Activity log tracks old and new values\n- Consider customer communication for changes\n- Setting null removes any duration limit\n\n**Authentication:** Requires valid X-API-Key header","operationId":"updateMaxCyclesV2","parameters":["9b87a2bc-a9e0-4645-ba79-f14722e515a9","e27ee3ac-eb23-4709-8541-4450232dc9a8","d97f807c-8611-4908-9929-ac3593971262","9eb521eb-b4a2-4bef-a7fd-4f2e115e4f9f"],"responses":{"200":"0f177ff8-eb8c-4eb2-a964-f80611b8276c","400":"40ae0934-f1b0-4217-9b67-16c964e45b4c","401":"8fc60aef-4ae6-4ea8-9d6b-fd01c8aaac61","403":"35ac861b-f340-4d31-bf57-a8e87181e07c","404":"e74a75b6-d71f-4f6c-ba2d-c05840e2f007","422":"8a0130f8-e26e-4d19-a295-03ab8c5590e9"},"summary":"Update maximum cycles for a subscription contract","tags":["Subscription Management","Subscription Contracts"],"method":"put","type":"path","servers":["d3c9e56f-e67b-483f-979d-9b57afc23940"],"security":[],"path":"/api/external/v2/subscription-contracts-update-max-cycles","baseUrlOptions":["https://subscription-admin.appstle.com"],"title":"Update maximum cycles for a subscription contract","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","node","php","go","ruby"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9b87a2bc-a9e0-4645-ba79-f14722e515a9":{"description":"Contract ID","in":"query","name":"contractId","required":true,"schema":{"format":"int64","type":"integer","isRequired":true,"description":"Contract ID","uniqueKey":"","typeLabel":"integer\u003cint64>"}},"e27ee3ac-eb23-4709-8541-4450232dc9a8":{"description":"API Key (Deprecated - Use Header X-API-Key instead)","in":"query","name":"api_key","required":false,"schema":{"type":"string","isRequired":false,"description":"API Key (Deprecated - Use Header X-API-Key instead)","uniqueKey":"","typeLabel":"string"}},"d97f807c-8611-4908-9929-ac3593971262":{"in":"header","name":"X-API-Key","required":false,"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"9eb521eb-b4a2-4bef-a7fd-4f2e115e4f9f":{"description":"Maximum Cycles. The total number of orders after which the subscription will automatically terminate. Must be greater than or equal to the current cycle count and any configured minimum cycles. Common values:\n- 3: Three-order trial\n- 6: Six-month seasonal subscription\n- 12: Annual subscription\n- 24: Two-year commitment\n- null: Ongoing subscription with no end date","example":12,"in":"query","name":"maxCycles","required":true,"schema":{"oneOf":[{"maximum":9999,"minimum":1,"type":"integer","description":"Maximum Cycles. The total number of orders after which the subscription will automatically terminate. Must be greater than or equal to the current cycle count and any configured minimum cycles. Common values:\n- 3: Three-order trial\n- 6: Six-month seasonal subscription\n- 12: Annual subscription\n- 24: Two-year commitment\n- null: Ongoing subscription with no end date","isRequired":true,"uniqueKey":"oneOf.0","typeLabel":"integer"},{"maximum":9999,"minimum":1,"type":"null","description":"Maximum Cycles. The total number of orders after which the subscription will automatically terminate. Must be greater than or equal to the current cycle count and any configured minimum cycles. Common values:\n- 3: Three-order trial\n- 6: Six-month seasonal subscription\n- 12: Annual subscription\n- 24: Two-year commitment\n- null: Ongoing subscription with no end date","isRequired":true,"uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"","typeLabel":"integer | null"}}},"responses":{"0f177ff8-eb8c-4eb2-a964-f80611b8276c":{"content":{"application/json":{"examples":{"Success Response":{"title":"Success Response","description":"Success Response","value":{"billingPolicy":{"anchors":[{"day":15,"type":"MONTHDAY"}],"interval":"MONTH","intervalCount":1,"maxCycles":12,"minCycles":3},"createdAt":"2024-01-01T00:00:00Z","customer":{"displayName":"John Doe","email":"customer@example.com","id":"gid://shopify/Customer/987654321"},"deliveryPolicy":{"interval":"MONTH","intervalCount":1},"id":"gid://shopify/SubscriptionContract/123456789","lastBillingAttemptDate":"2024-03-01T00:00:00Z","lines":{"edges":[{"node":{"currentPrice":{"amount":"39.99","currencyCode":"USD"},"id":"gid://shopify/SubscriptionLine/111111","quantity":1,"title":"12-Month Subscription Box","variantId":"gid://shopify/ProductVariant/42549172011164"}}]},"nextBillingDate":"2024-04-01T00:00:00Z","orders":{"edges":[{"node":{"createdAt":"2024-03-01T00:00:00Z","financialStatus":"PAID","fulfillmentStatus":"FULFILLED","id":"gid://shopify/Order/5678901234"}},{"node":{"createdAt":"2024-02-01T00:00:00Z","financialStatus":"PAID","fulfillmentStatus":"FULFILLED","id":"gid://shopify/Order/5678901233"}},{"node":{"createdAt":"2024-01-01T00:00:00Z","financialStatus":"PAID","fulfillmentStatus":"FULFILLED","id":"gid://shopify/Order/5678901232"}}]},"status":"ACTIVE"}}},"schema":{"properties":{"billingAttempts":{"properties":{"get__typename":{"type":"string","uniqueKey":"billingAttempts.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"completedAt":{"type":"object","uniqueKey":"billingAttempts.nodes.items.[INDEX].completedAt","typeLabel":"object"},"createdAt":{"type":"object","uniqueKey":"billingAttempts.nodes.items.[INDEX].createdAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"billingAttempts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"billingAttempts.nodes.items.[INDEX].id","typeLabel":"string"},"idempotencyKey":{"type":"string","uniqueKey":"billingAttempts.nodes.items.[INDEX].idempotencyKey","typeLabel":"string"},"ready":{"deprecated":true,"type":"boolean","uniqueKey":"billingAttempts.nodes.items.[INDEX].ready","typeLabel":"boolean"}},"type":"object","uniqueKey":"billingAttempts.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"billingAttempts.nodes","typeLabel":"object[]"}},"type":"object","uniqueKey":"billingAttempts","typeLabel":"object"},"billingPolicy":{"properties":{"anchors":{"items":{"properties":{"cutoffDay":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.anchors.items.[INDEX].cutoffDay","typeLabel":"integer\u003cint32>"},"day":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.anchors.items.[INDEX].day","typeLabel":"integer\u003cint32>"},"get__typename":{"type":"string","uniqueKey":"billingPolicy.anchors.items.[INDEX].get__typename","typeLabel":"string"},"month":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.anchors.items.[INDEX].month","typeLabel":"integer\u003cint32>"},"type":{"enum":["WEEKDAY","MONTHDAY","YEARDAY","$UNKNOWN"],"type":"string","uniqueKey":"billingPolicy.anchors.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"billingPolicy.anchors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"billingPolicy.anchors","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"billingPolicy.get__typename","typeLabel":"string"},"interval":{"enum":["DAY","WEEK","MONTH","YEAR","$UNKNOWN"],"type":"string","uniqueKey":"billingPolicy.interval","typeLabel":"enum\u003cstring>"},"intervalCount":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.intervalCount","typeLabel":"integer\u003cint32>"},"maxCycles":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.maxCycles","typeLabel":"integer\u003cint32>"},"minCycles":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.minCycles","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"billingPolicy","typeLabel":"object"},"createdAt":{"type":"object","uniqueKey":"createdAt","typeLabel":"object"},"customAttributes":{"items":{"properties":{"get__typename":{"type":"string","uniqueKey":"customAttributes.items.[INDEX].get__typename","typeLabel":"string"},"key":{"type":"string","uniqueKey":"customAttributes.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","uniqueKey":"customAttributes.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"customAttributes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"customAttributes","typeLabel":"object[]"},"customer":{"properties":{"displayName":{"type":"string","uniqueKey":"customer.displayName","typeLabel":"string"},"email":{"deprecated":true,"type":"string","uniqueKey":"customer.email","typeLabel":"string"},"firstName":{"type":"string","uniqueKey":"customer.firstName","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"customer.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"customer.id","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"customer.lastName","typeLabel":"string"},"phone":{"deprecated":true,"type":"string","uniqueKey":"customer.phone","typeLabel":"string"}},"type":"object","uniqueKey":"customer","typeLabel":"object"},"customerPaymentMethod":{"properties":{"get__typename":{"type":"string","uniqueKey":"customerPaymentMethod.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"customerPaymentMethod.id","typeLabel":"string"},"instrument":{"properties":{"get__typename":{"type":"string","uniqueKey":"customerPaymentMethod.instrument.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"customerPaymentMethod.instrument","typeLabel":"object"},"revokedAt":{"type":"object","uniqueKey":"customerPaymentMethod.revokedAt","typeLabel":"object"},"revokedReason":{"enum":["AUTHORIZE_NET_GATEWAY_NOT_ENABLED","AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD","FAILED_TO_UPDATE_CREDIT_CARD","STRIPE_API_AUTHENTICATION_ERROR","STRIPE_API_INVALID_REQUEST_ERROR","STRIPE_GATEWAY_NOT_ENABLED","STRIPE_RETURNED_NO_PAYMENT_METHOD","STRIPE_PAYMENT_METHOD_NOT_CARD","BRAINTREE_API_AUTHENTICATION_ERROR","BRAINTREE_GATEWAY_NOT_ENABLED","BRAINTREE_RETURNED_NO_PAYMENT_METHOD","BRAINTREE_PAYMENT_METHOD_NOT_CARD","PAYMENT_METHOD_VERIFICATION_FAILED","THREE_D_SECURE_FLOW_IN_VERIFICATION_NOT_IMPLEMENTED","MANUALLY_REVOKED","FAILED_TO_RETRIEVE_BILLING_ADDRESS","MERGED","CUSTOMER_REDACTED","TOO_MANY_CONSECUTIVE_FAILURES","CVV_ATTEMPTS_LIMIT_EXCEEDED","$UNKNOWN"],"type":"string","uniqueKey":"customerPaymentMethod.revokedReason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"customerPaymentMethod","typeLabel":"object"},"deliveryMethod":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod","typeLabel":"object"},"deliveryPolicy":{"properties":{"anchors":{"items":{"properties":{"cutoffDay":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].cutoffDay","typeLabel":"integer\u003cint32>"},"day":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].day","typeLabel":"integer\u003cint32>"},"get__typename":{"type":"string","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].get__typename","typeLabel":"string"},"month":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].month","typeLabel":"integer\u003cint32>"},"type":{"enum":["WEEKDAY","MONTHDAY","YEARDAY","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"deliveryPolicy.anchors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"deliveryPolicy.anchors","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"deliveryPolicy.get__typename","typeLabel":"string"},"interval":{"enum":["DAY","WEEK","MONTH","YEAR","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPolicy.interval","typeLabel":"enum\u003cstring>"},"intervalCount":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.intervalCount","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"deliveryPolicy","typeLabel":"object"},"deliveryPrice":{"properties":{"amount":{"type":"object","uniqueKey":"deliveryPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"deliveryPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryPrice","typeLabel":"object"},"discounts":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].id","typeLabel":"string"},"recurringCycleLimit":{"format":"int32","type":"integer","uniqueKey":"discounts.nodes.items.[INDEX].recurringCycleLimit","typeLabel":"integer\u003cint32>"},"rejectionReason":{"enum":["NOT_FOUND","NO_ENTITLED_LINE_ITEMS","QUANTITY_NOT_IN_RANGE","PURCHASE_NOT_IN_RANGE","CUSTOMER_NOT_ELIGIBLE","USAGE_LIMIT_REACHED","CUSTOMER_USAGE_LIMIT_REACHED","CURRENTLY_INACTIVE","NO_ENTITLED_SHIPPING_LINES","INCOMPATIBLE_PURCHASE_TYPE","INTERNAL_ERROR","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].rejectionReason","typeLabel":"enum\u003cstring>"},"targetType":{"enum":["LINE_ITEM","SHIPPING_LINE","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].targetType","typeLabel":"enum\u003cstring>"},"title":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["MANUAL","CODE_DISCOUNT","AUTOMATIC_DISCOUNT","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"usageCount":{"format":"int32","type":"integer","uniqueKey":"discounts.nodes.items.[INDEX].usageCount","typeLabel":"integer\u003cint32>"},"value":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].value.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].value","typeLabel":"object"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"discounts.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"discounts.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"discounts.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"discounts.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"discounts.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"discounts.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"discounts.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"discounts","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"lastPaymentStatus":{"enum":["SUCCEEDED","FAILED","$UNKNOWN"],"type":"string","uniqueKey":"lastPaymentStatus","typeLabel":"enum\u003cstring>"},"lines":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"currentPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].currentPrice","typeLabel":"object"},"customAttributes":{"items":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].get__typename","typeLabel":"string"},"key":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].customAttributes","typeLabel":"object[]"},"discountAllocations":{"items":{"properties":{"amount":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount","typeLabel":"object"},"discount":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].discount.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].discount","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].id","typeLabel":"string"},"lineDiscountedPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice","typeLabel":"object"},"pricingPolicy":{"properties":{"basePrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice","typeLabel":"object"},"cycleDiscounts":{"items":{"properties":{"adjustmentType":{"enum":["PERCENTAGE","FIXED_AMOUNT","PRICE","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentType","typeLabel":"enum\u003cstring>"},"adjustmentValue":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentValue.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentValue","typeLabel":"object"},"afterCycle":{"format":"int32","type":"integer","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].afterCycle","typeLabel":"integer\u003cint32>"},"computedPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy","typeLabel":"object"},"productId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].productId","typeLabel":"string"},"quantity":{"format":"int32","type":"integer","uniqueKey":"lines.nodes.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"sellingPlanId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sellingPlanId","typeLabel":"string"},"sellingPlanName":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sellingPlanName","typeLabel":"string"},"sku":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sku","typeLabel":"string"},"taxable":{"type":"boolean","uniqueKey":"lines.nodes.items.[INDEX].taxable","typeLabel":"boolean"},"title":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].title","typeLabel":"string"},"variantId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantId","typeLabel":"string"},"variantImage":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantImage.get__typename","typeLabel":"string"},"url":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].variantImage.url","typeLabel":"object"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].variantImage","typeLabel":"object"},"variantTitle":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantTitle","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"lines.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"lines.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"lines.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"lines.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"lines.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"lines.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"lines","typeLabel":"object"},"nextBillingDate":{"type":"object","uniqueKey":"nextBillingDate","typeLabel":"object"},"note":{"type":"string","uniqueKey":"note","typeLabel":"string"},"originOrder":{"properties":{"fulfillmentOrders":{"properties":{"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"fulfillAt":{"type":"object","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].fulfillAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].id","typeLabel":"string"},"status":{"enum":["OPEN","IN_PROGRESS","CANCELLED","INCOMPLETE","CLOSED","SCHEDULED","ON_HOLD","$UNKNOWN"],"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"originOrder.fulfillmentOrders.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"originOrder.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"originOrder.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"originOrder.name","typeLabel":"string"}},"type":"object","uniqueKey":"originOrder","typeLabel":"object"},"revisionId":{"type":"object","uniqueKey":"revisionId","typeLabel":"object"},"status":{"enum":["ACTIVE","PAUSED","CANCELLED","EXPIRED","FAILED","$UNKNOWN"],"type":"string","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"object","uniqueKey":"updatedAt","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Maximum cycles updated successfully","exampleType":"examples"},"40ae0934-f1b0-4217-9b67-16c964e45b4c":{"content":{"application/json":{"examples":{"Already Cancelled":{"title":"Already Cancelled","description":"Already Cancelled","value":{"detail":"Cannot modify maximum cycles for cancelled subscriptions","status":400,"title":"UserGeneratedError:Cannot update cancelled subscription","type":"https://example.com/errors/bad-request"}},"Contract Not Found":{"title":"Contract Not Found","description":"Contract Not Found","value":{"detail":"No subscription contract found with ID 123456789","status":400,"title":"Subscription contract not found","type":"https://example.com/errors/bad-request"}},"Invalid Max Cycles Value":{"title":"Invalid Max Cycles Value","description":"Invalid Max Cycles Value","value":{"detail":"Maximum cycles must be a positive integer","status":400,"title":"Invalid maximum cycles value","type":"https://example.com/errors/bad-request"}},"Max Cycles Below Current Cycle":{"title":"Max Cycles Below Current Cycle","description":"Max Cycles Below Current Cycle","value":{"detail":"Cannot set maximum cycles to 3 when subscription has already completed 5 cycles","status":400,"title":"UserGeneratedError:Max cycles cannot be set to less than current cycle","type":"https://example.com/errors/bad-request"}},"Max Less Than Min Cycles":{"title":"Max Less Than Min Cycles","description":"Max Less Than Min Cycles","value":{"detail":"Cannot set maximum cycles (6) to less than minimum cycles (12)","status":400,"title":"UserGeneratedError:Maximum cycles cannot be less than minimum cycles","type":"https://example.com/errors/bad-request"}}},"exampleType":"examples"}},"description":"Invalid request parameters or business rule violation","exampleType":"examples"},"8fc60aef-4ae6-4ea8-9d6b-fd01c8aaac61":{"content":{"application/json":{"example":{"detail":"Valid X-API-Key header is required","status":401,"title":"Authentication required","type":"https://example.com/errors/unauthorized"},"examples":{"Example":{"title":"Example","value":{"detail":"Valid X-API-Key header is required","status":401,"title":"Authentication required","type":"https://example.com/errors/unauthorized"}}},"exampleType":"examples"}},"description":"Authentication required","exampleType":"examples"},"35ac861b-f340-4d31-bf57-a8e87181e07c":{"content":{"application/json":{"example":{"detail":"API key does not have permission to modify subscription contracts","status":403,"title":"Insufficient permissions","type":"https://example.com/errors/forbidden"},"examples":{"Example":{"title":"Example","value":{"detail":"API key does not have permission to modify subscription contracts","status":403,"title":"Insufficient permissions","type":"https://example.com/errors/forbidden"}}},"exampleType":"examples"}},"description":"Insufficient permissions to update maximum cycles","exampleType":"examples"},"e74a75b6-d71f-4f6c-ba2d-c05840e2f007":{"content":{"application/json":{"example":{"detail":"Subscription contract with ID 123456789 not found in the system","status":404,"title":"Resource not found","type":"https://example.com/errors/not-found"},"examples":{"Example":{"title":"Example","value":{"detail":"Subscription contract with ID 123456789 not found in the system","status":404,"title":"Resource not found","type":"https://example.com/errors/not-found"}}},"exampleType":"examples"}},"description":"Subscription contract not found","exampleType":"examples"},"8a0130f8-e26e-4d19-a295-03ab8c5590e9":{"content":{"application/json":{"examples":{"Queue Update Failed":{"title":"Queue Update Failed","description":"Queue Update Failed","value":{"detail":"Failed to reschedule upcoming orders based on new maximum cycles","status":422,"title":"Unable to update order queue","type":"https://example.com/errors/unprocessable-entity"}},"Shopify API Error":{"title":"Shopify API Error","description":"Shopify API Error","value":{"detail":"Shopify API error: Cannot modify subscription during active billing attempt","status":422,"title":"UserGeneratedError:Unable to update maximum cycles","type":"https://example.com/errors/unprocessable-entity"}}},"exampleType":"examples"}},"description":"Maximum cycles update failed due to Shopify constraints","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":"Update maximum cycles for a subscription contract - Appstle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-08T12:41:24.374Z","originalFileLocation":"subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract.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=\"Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders. What are Maximum Cycles? Maximum cycles define subscription duration limits where: - Subscription automatically cancels after the specified number of orders - No further orders are generated once maximum is reached - Useful for fixed-term offers, trials, or seasonal subscriptions - Customer is notified before final order (if configured) Key Features: - Cannot set below current cycle count (prevents immediate cancellation) - Setting to null creates an indefinite subscription - Automatically reschedules order queue based on new limit - Preserves all other subscription settings - Validates against current subscription progress Current Cycle Calculation: - Current cycle = Successful billing attempts + 1 - Failed payments don\u0026#x27;t count toward maximum - First order is cycle 1, second is cycle 2, etc. - System prevents setting max below current position Common Use Cases: - Trial Subscriptions: \u0026#x27;3-box trial\u0026#x27; that auto-ends - Seasonal Programs: \u0026#x27;6-month summer subscription\u0026#x27; - Limited Series: \u0026#x27;12-issue magazine subscription\u0026#x27; - Promotional Offers: \u0026#x27;First 5 boxes at special price\u0026#x27; - Gift Subscriptions: Fixed duration gifts that don\u0026#x27;t renew What Happens at Maximum: When a subscription reaches its maximum cycles: 1. Final order is processed normally 2. Subscription status changes to CANCELLED 3. No future orders are scheduled 4. Customer receives cancellation notification 5. Cannot be reactivated (new subscription required) Interaction with Min Cycles: - Can have both min and max (e.g., 3 min, 12 max) - Min cycles enforces commitment period - Max cycles enforces termination - Common pattern: Commitment with defined end Queue Management: After updating max cycles: - System recalculates future order schedule - Removes orders beyond the new maximum - Adjusts upcoming order notifications - Updates subscription end date projections Important Notes: - Validation prevents accidental immediate cancellation - Changes apply to future billing cycles only - Activity log tracks old and new values - Consider customer communication for changes - Setting null removes any duration limit 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=\"Update maximum cycles for a subscription contract - Appstle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders. What are Maximum Cycles? Maximum cycles define subscription duration limits where: - Subscription automatically cancels after the specified number of orders - No further orders are generated once maximum is reached - Useful for fixed-term offers, trials, or seasonal subscriptions - Customer is notified before final order (if configured) Key Features: - Cannot set below current cycle count (prevents immediate cancellation) - Setting to null creates an indefinite subscription - Automatically reschedules order queue based on new limit - Preserves all other subscription settings - Validates against current subscription progress Current Cycle Calculation: - Current cycle = Successful billing attempts + 1 - Failed payments don\u0026#x27;t count toward maximum - First order is cycle 1, second is cycle 2, etc. - System prevents setting max below current position Common Use Cases: - Trial Subscriptions: \u0026#x27;3-box trial\u0026#x27; that auto-ends - Seasonal Programs: \u0026#x27;6-month summer subscription\u0026#x27; - Limited Series: \u0026#x27;12-issue magazine subscription\u0026#x27; - Promotional Offers: \u0026#x27;First 5 boxes at special price\u0026#x27; - Gift Subscriptions: Fixed duration gifts that don\u0026#x27;t renew What Happens at Maximum: When a subscription reaches its maximum cycles: 1. Final order is processed normally 2. Subscription status changes to CANCELLED 3. No future orders are scheduled 4. Customer receives cancellation notification 5. Cannot be reactivated (new subscription required) Interaction with Min Cycles: - Can have both min and max (e.g., 3 min, 12 max) - Min cycles enforces commitment period - Max cycles enforces termination - Common pattern: Commitment with defined end Queue Management: After updating max cycles: - System recalculates future order schedule - Removes orders beyond the new maximum - Adjusts upcoming order notifications - Updates subscription end date projections Important Notes: - Validation prevents accidental immediate cancellation - Changes apply to future billing cycles only - Activity log tracks old and new values - Consider customer communication for changes - Setting null removes any duration limit 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-management/update-maximum-cycles-for-a-subscription-contract\">\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+Management\u0026amp;title=Update+maximum+cycles+for+a+subscription+contract\u0026amp;description=Updates+the+maximum+number+of+billing+cycles+%28orders%29+after+which+a+subscription+will+automatically+terminate.+This+creates+a+fixed-duration+subscription+that+e\u0026amp;theme=5c3420c08540c444b143045f\u0026amp;signature=e87a2cb51c43dce6c3d454d3620529ddd8faa63a4112c8286f215c239fa78a92\">\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=\"Update maximum cycles for a subscription contract - Appstle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders. What are Maximum Cycles? Maximum cycles define subscription duration limits where: - Subscription automatically cancels after the specified number of orders - No further orders are generated once maximum is reached - Useful for fixed-term offers, trials, or seasonal subscriptions - Customer is notified before final order (if configured) Key Features: - Cannot set below current cycle count (prevents immediate cancellation) - Setting to null creates an indefinite subscription - Automatically reschedules order queue based on new limit - Preserves all other subscription settings - Validates against current subscription progress Current Cycle Calculation: - Current cycle = Successful billing attempts + 1 - Failed payments don\u0026#x27;t count toward maximum - First order is cycle 1, second is cycle 2, etc. - System prevents setting max below current position Common Use Cases: - Trial Subscriptions: \u0026#x27;3-box trial\u0026#x27; that auto-ends - Seasonal Programs: \u0026#x27;6-month summer subscription\u0026#x27; - Limited Series: \u0026#x27;12-issue magazine subscription\u0026#x27; - Promotional Offers: \u0026#x27;First 5 boxes at special price\u0026#x27; - Gift Subscriptions: Fixed duration gifts that don\u0026#x27;t renew What Happens at Maximum: When a subscription reaches its maximum cycles: 1. Final order is processed normally 2. Subscription status changes to CANCELLED 3. No future orders are scheduled 4. Customer receives cancellation notification 5. Cannot be reactivated (new subscription required) Interaction with Min Cycles: - Can have both min and max (e.g., 3 min, 12 max) - Min cycles enforces commitment period - Max cycles enforces termination - Common pattern: Commitment with defined end Queue Management: After updating max cycles: - System recalculates future order schedule - Removes orders beyond the new maximum - Adjusts upcoming order notifications - Updates subscription end date projections Important Notes: - Validation prevents accidental immediate cancellation - Changes apply to future billing cycles only - Activity log tracks old and new values - Consider customer communication for changes - Setting null removes any duration limit 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+Management\u0026amp;title=Update+maximum+cycles+for+a+subscription+contract\u0026amp;description=Updates+the+maximum+number+of+billing+cycles+%28orders%29+after+which+a+subscription+will+automatically+terminate.+This+creates+a+fixed-duration+subscription+that+e\u0026amp;theme=5c3420c08540c444b143045f\u0026amp;signature=e87a2cb51c43dce6c3d454d3620529ddd8faa63a4112c8286f215c239fa78a92\">\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-management/update-maximum-cycles-for-a-subscription-contract\">\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-management/update-maximum-cycles-for-a-subscription-contract.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-management/update-maximum-cycles-for-a-subscription-contract#webpage\",\"url\":\"https://developers.appstle.com/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract\",\"name\":\"Update maximum cycles for a subscription contract\",\"description\":\"Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders. What are Maximum Cycles? Maximum cycles define subscription duration limits where: - Subscription automatically cancels after the specified number of orders - No further orders are generated once maximum is reached - Useful for fixed-term offers, trials, or seasonal subscriptions - Customer is notified before final order (if configured) Key Features: - Cannot set below current cycle count (prevents immediate cancellation) - Setting to null creates an indefinite subscription - Automatically reschedules order queue based on new limit - Preserves all other subscription settings - Validates against current subscription progress Current Cycle Calculation: - Current cycle = Successful billing attempts + 1 - Failed payments don't count toward maximum - First order is cycle 1, second is cycle 2, etc. - System prevents setting max below current position Common Use Cases: - Trial Subscriptions: '3-box trial' that auto-ends - Seasonal Programs: '6-month summer subscription' - Limited Series: '12-issue magazine subscription' - Promotional Offers: 'First 5 boxes at special price' - Gift Subscriptions: Fixed duration gifts that don't renew What Happens at Maximum: When a subscription reaches its maximum cycles: 1. Final order is processed normally 2. Subscription status changes to CANCELLED 3. No future orders are scheduled 4. Customer receives cancellation notification 5. Cannot be reactivated (new subscription required) Interaction with Min Cycles: - Can have both min and max (e.g., 3 min, 12 max) - Min cycles enforces commitment period - Max cycles enforces termination - Common pattern: Commitment with defined end Queue Management: After updating max cycles: - System recalculates future order schedule - Removes orders beyond the new maximum - Adjusts upcoming order notifications - Updates subscription end date projections Important Notes: - Validation prevents accidental immediate cancellation - Changes apply to future billing cycles only - Activity log tracks old and new values - Consider customer communication for changes - Setting null removes any duration limit Authentication: Requires valid X-API-Key header\",\"dateModified\":\"2026-11-08T12:41:24.374Z\",\"isPartOf\":{\"@id\":\"https://developers.appstle.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.appstle.com/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.appstle.com/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract#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 Management\",\"item\":\"https://developers.appstle.com/subscription-admin-api/subscription-management/list-quick-checkout-links\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update maximum cycles for a subscription contract\",\"item\":\"https://developers.appstle.com/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.appstle.com/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract#apireference\",\"headline\":\"Update maximum cycles for a subscription contract\",\"name\":\"Update maximum cycles for a subscription contract\",\"description\":\"Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders. What are Maximum Cycles? Maximum cycles define subscription duration limits where: - Subscription automatically cancels after the specified number of orders - No further orders are generated once maximum is reached - Useful for fixed-term offers, trials, or seasonal subscriptions - Customer is notified before final order (if configured) Key Features: - Cannot set below current cycle count (prevents immediate cancellation) - Setting to null creates an indefinite subscription - Automatically reschedules order queue based on new limit - Preserves all other subscription settings - Validates against current subscription progress Current Cycle Calculation: - Current cycle = Successful billing attempts + 1 - Failed payments don't count toward maximum - First order is cycle 1, second is cycle 2, etc. - System prevents setting max below current position Common Use Cases: - Trial Subscriptions: '3-box trial' that auto-ends - Seasonal Programs: '6-month summer subscription' - Limited Series: '12-issue magazine subscription' - Promotional Offers: 'First 5 boxes at special price' - Gift Subscriptions: Fixed duration gifts that don't renew What Happens at Maximum: When a subscription reaches its maximum cycles: 1. Final order is processed normally 2. Subscription status changes to CANCELLED 3. No future orders are scheduled 4. Customer receives cancellation notification 5. Cannot be reactivated (new subscription required) Interaction with Min Cycles: - Can have both min and max (e.g., 3 min, 12 max) - Min cycles enforces commitment period - Max cycles enforces termination - Common pattern: Commitment with defined end Queue Management: After updating max cycles: - System recalculates future order schedule - Removes orders beyond the new maximum - Adjusts upcoming order notifications - Updates subscription end date projections Important Notes: - Validation prevents accidental immediate cancellation - Changes apply to future billing cycles only - Activity log tracks old and new values - Consider customer communication for changes - Setting null removes any duration limit Authentication: Requires valid X-API-Key header\",\"url\":\"https://developers.appstle.com/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract\",\"mainEntityOfPage\":{\"@id\":\"https://developers.appstle.com/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract#webpage\"},\"dateModified\":\"2026-11-08T12:41:24.374Z\",\"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-management/update-maximum-cycles-for-a-subscription-contract.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","description":"Sets the \"Use Custom Delivery Price\" option (`allowDeliveryPriceOverride`) for a subscription contract.\nThis is the same checkbox shown in the Delivery Information section of the subscription in the merchant portal.\n\n- **true**: The contract keeps its current delivery price. Automatic shipping price syncs from your Shopify\n shipping settings are skipped for this contract, except after a delivery address update that switches the\n delivery type while the \"Recalculate shipping price when delivery method changes\" setting is on. Use this\n together with `PUT /api/external/v2/subscription-contracts-update-delivery-price` to keep a manually set price.\n- **false**: The delivery price syncs with your Shopify shipping settings again. When the option is turned off,\n the delivery price is recalculated from your Shopify shipping rates in the background (unless automatic\n shipping price calculation is turned off in your shop settings).\n\nSending the value the contract already has makes no changes.\n\nAuthentication is enforced via the X-API-Key header (the 'api_key' parameter is deprecated).\n","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","description":"Updates the minimum number of billing cycles (orders) that a customer must complete before they can cancel their subscription. This creates a commitment period that helps with customer retention and business predictability.\n\n**What are Minimum Cycles?**\nMinimum cycles represent a commitment period where:\n- Customers must complete a specified number of orders\n- Cancellation is blocked until the minimum is met\n- Often tied to special pricing or promotional offers\n- Counted from the subscription start date\n\n**Key Features:**\n- Updates commitment period for existing subscriptions\n- Can increase or decrease minimum cycles\n- Setting to null removes the minimum commitment\n- Preserves all other subscription settings\n- Automatically handles invalid discount codes\n- Updates future billing queue after change\n\n**Common Use Cases:**\n- **Promotional Offers**: '3-month minimum for 50% off'\n- **Hardware Subsidies**: '12-month commitment with free device'\n- **Loyalty Programs**: Reduce minimum after customer proves loyalty\n- **Seasonal Campaigns**: Temporary commitment requirements\n- **Contract Adjustments**: Customer service exceptions\n\n**Impact on Customers:**\n- Cannot cancel via portal until minimum cycles complete\n- Pause/resume typically still allowed (check settings)\n- Shows commitment status in customer portal\n- No automatic notification sent (consider sending separately)\n\n**Cycle Counting:**\n- Only successful billing attempts count toward minimum\n- Failed payments don't increment the cycle count\n- Skipped orders (if allowed) don't count\n- Current cycle = successful past orders + 1\n\n**Interaction with Max Cycles:**\n- Min cycles must be less than or equal to max cycles\n- If max cycles exist, subscription auto-cancels after maximum\n- Common pattern: 3 min cycles, 12 max cycles\n\n**Best Practices:**\n- Clearly communicate commitment terms upfront\n- Consider grandfathering existing customers\n- Use reasonable minimums (typically 3-12 cycles)\n- Document reason for changes in activity logs\n- Send customer notification for transparency\n\n**Important Notes:**\n- Changes apply immediately to cancellation logic\n- Doesn't affect past or in-progress orders\n- Customer portal respects this setting automatically\n- Activity log tracks old and new values\n- Consider legal requirements in your jurisdiction\n\n**Authentication:** Requires valid X-API-Key header","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","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","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":"Update maximum cycles for a subscription contract - 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"]}