Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders.
Key Features:
Add Products: Include new products in future membership deliveries
Quantity Control: Specify how many units of the product to add
Price Override: Set custom pricing for the added product
Immediate Effect: Changes apply to next billing cycle
Activity Logging: All additions are tracked in activity logs
Required Parameters:
contractId: Membership contract ID to modify
variantId: Shopify product variant ID (with gid:// prefix or numeric)
quantity: Number of units to add (must be positive integer)
{"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":"github","href":"https://github.com/AppstleInc"}},"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":""},"chroma":{"liveDeploymentHistoryId":"6adfa33f64308ab65ed2456b","collectionId":"d72b93ab-daca-4f97-a891-c13ef4624f35","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfa33f64308ab65ed2456b"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae04bff87a96311da529678","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Subscriptions","count":262},{"language":"default","tag":"Admin API","count":183},{"language":"default","tag":"Storefront API","count":172},{"language":"default","tag":"Memberships","count":118},{"language":"default","tag":"Subscription Contracts","count":63},{"language":"default","tag":"Membership Contracts","count":62},{"language":"default","tag":"Customer Portal API","count":55},{"language":"default","tag":"Loyalty","count":46},{"language":"default","tag":"Billing \u0026 Payments","count":28},{"language":"default","tag":"Bundles","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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract","slug":"/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract","pageMetadata":{"title":"Add product line item to membership contract","description":"Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders.\n\n**Key Features:**\n- **Add Products**: Include new products in future membership deliveries\n- **Quantity Control**: Specify how many units of the product to add\n- **Price Override**: Set custom pricing for the added product\n- **Immediate Effect**: Changes apply to next billing cycle\n- **Activity Logging**: All additions are tracked in activity logs\n\n**Required Parameters:**\n- **contractId**: Membership contract ID to modify\n- **variantId**: Shopify product variant ID (with gid:// prefix or numeric)\n- **quantity**: Number of units to add (must be positive integer)\n- **price**: Price per unit in shop's base currency\n\n**Product Variant ID Format:**\nAccepts two formats:\n- Shopify GID: `gid://shopify/ProductVariant/12345678901`\n- Numeric ID: `12345678901`\n\n**Price Behavior:**\n- Price is per unit, not total\n- Must be in shop's base currency (USD, EUR, etc.)\n- Can override product's default price\n- Does not include taxes or shipping\n- Total line item cost = price × quantity\n\n**Line Item Addition Rules:**\n- Product variant must exist in Shopify catalog\n- Product must be active and available\n- Variant must have sufficient inventory (if tracked)\n- Contract must be ACTIVE or PAUSED (not CANCELLED)\n- Cannot add duplicate variants (use update quantity instead)\n\n**Common Use Cases:**\n- Customer adds complementary product to existing membership\n- Upsell additional products through customer portal\n- Merchant adds bonus items to customer memberships\n- Build custom \"add-on\" product selection interfaces\n- Cross-sell related products to existing subscribers\n- Create bundle upgrades (add multiple products at once)\n\n**Post-Addition Effects:**\n- Next billing amount increases by (price × quantity)\n- Product appears in all future membership deliveries\n- Customer receives confirmation of membership update\n- Activity log records the addition with source (portal/merchant)\n- Contract's next billing date remains unchanged\n\n**Integration Example:**\n```\nPUT /api/external/v2/subscription-contract-add-line-item?\n contractId=123456\u0026\n variantId=gid://shopify/ProductVariant/987654321\u0026\n quantity=2\u0026\n price=19.99\n```\nThis adds 2 units of variant 987654321 at $19.99 each ($39.98 total) to contract 123456.\n\n**Important Notes:**\n- Changes apply to NEXT billing cycle, not current/past orders\n- If product is out of stock, order may be delayed or skipped\n- Price changes don't affect historical orders\n- Consider inventory availability before adding products\n\n**Authentication:** Requires API key authentication via X-API-Key header or api_key parameter","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contract-add-line-item","href":"/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-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 annotation: \"annotation\",\n code: \"code\",\n li: \"li\",\n math: \"math\",\n mi: \"mi\",\n mn: \"mn\",\n mo: \"mo\",\n mrow: \"mrow\",\n p: \"p\",\n pre: \"pre\",\n semantics: \"semantics\",\n span: \"span\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Key Features:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Add Products\"\n }), \": Include new products in future membership deliveries\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Quantity Control\"\n }), \": Specify how many units of the product to add\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Price Override\"\n }), \": Set custom pricing for the added product\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Immediate Effect\"\n }), \": Changes apply to next billing cycle\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Activity Logging\"\n }), \": All additions are tracked in activity logs\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Required Parameters:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"contractId\"\n }), \": Membership contract ID to modify\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"variantId\"\n }), \": Shopify product variant ID (with gid:// prefix or numeric)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"quantity\"\n }), \": Number of units to add (must be positive integer)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"price\"\n }), \": Price per unit in shop’s base currency\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Product Variant ID Format:\"\n }), \"\\nAccepts two formats:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Shopify GID: \", _jsx(_components.code, {\n children: \"gid://shopify/ProductVariant/12345678901\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Numeric ID: \", _jsx(_components.code, {\n children: \"12345678901\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Price Behavior:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Price is per unit, not total\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Must be in shop’s base currency (USD, EUR, etc.)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Can override product’s default price\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Does not include taxes or shipping\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Total line item cost = price × quantity\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Line Item Addition Rules:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Product variant must exist in Shopify catalog\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Product must be active and available\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Variant must have sufficient inventory (if tracked)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Contract must be ACTIVE or PAUSED (not CANCELLED)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Cannot add duplicate variants (use update quantity instead)\"\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\", _jsx(_components.li, {\n children: \"Customer adds complementary product to existing membership\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Upsell additional products through customer portal\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Merchant adds bonus items to customer memberships\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Build custom “add-on” product selection interfaces\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Cross-sell related products to existing subscribers\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Create bundle upgrades (add multiple products at once)\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Post-Addition Effects:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Next billing amount increases by (price × quantity)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Product appears in all future membership deliveries\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Customer receives confirmation of membership update\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Activity log records the addition with source (portal/merchant)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Contract’s next billing date remains unchanged\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Integration Example:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"6\",\n language: \"text\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"text\",\n children: _jsxs(_components.code, {\n language: \"text\",\n numberOfLines: \"6\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n children: \"PUT /api/external/v2/subscription-contract-add-line-item?\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n children: \" contractId=123456\u0026\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n children: \" variantId=gid://shopify/ProductVariant/987654321\u0026\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n children: \" quantity=2\u0026\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n children: \" price=19.99\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {})\n })]\n })\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This adds 2 units of variant 987654321 at \", _jsxs(_components.span, {\n className: \"katex\",\n children: [_jsx(_components.span, {\n className: \"katex-mathml\",\n children: _jsx(_components.math, {\n xmlns: \"http://www.w3.org/1998/Math/MathML\",\n children: _jsxs(_components.semantics, {\n children: [_jsxs(_components.mrow, {\n children: [_jsx(_components.mn, {\n children: \"19.99\"\n }), _jsx(_components.mi, {\n children: \"e\"\n }), _jsx(_components.mi, {\n children: \"a\"\n }), _jsx(_components.mi, {\n children: \"c\"\n }), _jsx(_components.mi, {\n children: \"h\"\n }), _jsx(_components.mo, {\n stretchy: \"false\",\n children: \"(\"\n })]\n }), _jsx(_components.annotation, {\n encoding: \"application/x-tex\",\n children: \"19.99 each (\"\n })]\n })\n })\n }), _jsx(_components.span, {\n className: \"katex-html\",\n \"aria-hidden\": \"true\",\n children: _jsxs(_components.span, {\n className: \"base\",\n children: [_jsx(_components.span, {\n className: \"strut\",\n style: {\n height: \"1em\",\n verticalAlign: \"-0.25em\"\n }\n }), _jsx(_components.span, {\n className: \"mord\",\n children: \"19.99\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"e\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"a\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"c\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"h\"\n }), _jsx(_components.span, {\n className: \"mopen\",\n children: \"(\"\n })]\n })\n })]\n }), \"39.98 total) to contract 123456.\"]\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: \"Changes apply to NEXT billing cycle, not current/past orders\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"If product is out of stock, order may be delayed or skipped\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Price changes don’t affect historical orders\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Consider inventory availability before adding products\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Authentication:\"\n }), \" Requires API key authentication via X-API-Key header or api_key parameter\"]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\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":"Add product line item to membership contract","description":"Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders.\n\n**Key Features:**\n- **Add Products**: Include new products in future membership deliveries\n- **Quantity Control**: Specify how many units of the product to add\n- **Price Override**: Set custom pricing for the added product\n- **Immediate Effect**: Changes apply to next billing cycle\n- **Activity Logging**: All additions are tracked in activity logs\n\n**Required Parameters:**\n- **contractId**: Membership contract ID to modify\n- **variantId**: Shopify product variant ID (with gid:// prefix or numeric)\n- **quantity**: Number of units to add (must be positive integer)\n- **price**: Price per unit in shop's base currency\n\n**Product Variant ID Format:**\nAccepts two formats:\n- Shopify GID: `gid://shopify/ProductVariant/12345678901`\n- Numeric ID: `12345678901`\n\n**Price Behavior:**\n- Price is per unit, not total\n- Must be in shop's base currency (USD, EUR, etc.)\n- Can override product's default price\n- Does not include taxes or shipping\n- Total line item cost = price × quantity\n\n**Line Item Addition Rules:**\n- Product variant must exist in Shopify catalog\n- Product must be active and available\n- Variant must have sufficient inventory (if tracked)\n- Contract must be ACTIVE or PAUSED (not CANCELLED)\n- Cannot add duplicate variants (use update quantity instead)\n\n**Common Use Cases:**\n- Customer adds complementary product to existing membership\n- Upsell additional products through customer portal\n- Merchant adds bonus items to customer memberships\n- Build custom \"add-on\" product selection interfaces\n- Cross-sell related products to existing subscribers\n- Create bundle upgrades (add multiple products at once)\n\n**Post-Addition Effects:**\n- Next billing amount increases by (price × quantity)\n- Product appears in all future membership deliveries\n- Customer receives confirmation of membership update\n- Activity log records the addition with source (portal/merchant)\n- Contract's next billing date remains unchanged\n\n**Integration Example:**\n```\nPUT /api/external/v2/subscription-contract-add-line-item?\n contractId=123456\u0026\n variantId=gid://shopify/ProductVariant/987654321\u0026\n quantity=2\u0026\n price=19.99\n```\nThis adds 2 units of variant 987654321 at $19.99 each ($39.98 total) to contract 123456.\n\n**Important Notes:**\n- Changes apply to NEXT billing cycle, not current/past orders\n- If product is out of stock, order may be delayed or skipped\n- Price changes don't affect historical orders\n- Consider inventory availability before adding products\n\n**Authentication:** Requires API key authentication via X-API-Key header or api_key parameter","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contract-add-line-item","href":"/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders.\n\n**Key Features:**\n- **Add Products**: Include new products in future membership deliveries\n- **Quantity Control**: Specify how many units of the product to add\n- **Price Override**: Set custom pricing for the added product\n- **Immediate Effect**: Changes apply to next billing cycle\n- **Activity Logging**: All additions are tracked in activity logs\n\n**Required Parameters:**\n- **contractId**: Membership contract ID to modify\n- **variantId**: Shopify product variant ID (with gid:// prefix or numeric)\n- **quantity**: Number of units to add (must be positive integer)\n- **price**: Price per unit in shop's base currency\n\n**Product Variant ID Format:**\nAccepts two formats:\n- Shopify GID: `gid://shopify/ProductVariant/12345678901`\n- Numeric ID: `12345678901`\n\n**Price Behavior:**\n- Price is per unit, not total\n- Must be in shop's base currency (USD, EUR, etc.)\n- Can override product's default price\n- Does not include taxes or shipping\n- Total line item cost = price × quantity\n\n**Line Item Addition Rules:**\n- Product variant must exist in Shopify catalog\n- Product must be active and available\n- Variant must have sufficient inventory (if tracked)\n- Contract must be ACTIVE or PAUSED (not CANCELLED)\n- Cannot add duplicate variants (use update quantity instead)\n\n**Common Use Cases:**\n- Customer adds complementary product to existing membership\n- Upsell additional products through customer portal\n- Merchant adds bonus items to customer memberships\n- Build custom \"add-on\" product selection interfaces\n- Cross-sell related products to existing subscribers\n- Create bundle upgrades (add multiple products at once)\n\n**Post-Addition Effects:**\n- Next billing amount increases by (price × quantity)\n- Product appears in all future membership deliveries\n- Customer receives confirmation of membership update\n- Activity log records the addition with source (portal/merchant)\n- Contract's next billing date remains unchanged\n\n**Integration Example:**\n```\nPUT /api/external/v2/subscription-contract-add-line-item?\n contractId=123456\u0026\n variantId=gid://shopify/ProductVariant/987654321\u0026\n quantity=2\u0026\n price=19.99\n```\nThis adds 2 units of variant 987654321 at $19.99 each ($39.98 total) to contract 123456.\n\n**Important Notes:**\n- Changes apply to NEXT billing cycle, not current/past orders\n- If product is out of stock, order may be delayed or skipped\n- Price changes don't affect historical orders\n- Consider inventory availability before adding products\n\n**Authentication:** Requires API key authentication via X-API-Key header or api_key parameter","operationId":"addLineItemV2_1","parameters":["cf13cc78-3ece-4c44-b31e-baeed01305e9","72c5b980-2178-4931-b318-25cba5e86fc6","2e3eb3c0-8d40-4f7d-ad29-c8874755f795","0f285810-1386-4b96-bb67-5df950b364d3","75db0523-695b-419c-8db1-2ae9059e2502","9d886b4a-2ceb-4cc6-9e34-3ec4d7f06451"],"responses":{"200":"2109a2a5-a2ba-41ce-9828-87a72feafe50","400":"39246568-f206-40fc-a9d5-2d863187257b","401":"d1598f33-491f-4f9f-be28-eee0a745c82e","403":"c231e957-80e4-4bdc-9ece-f9c63f8bf1a4","404":"c0e510c6-449e-4c0e-b8e4-3eedb5fb495b"},"summary":"Add product line item to membership contract","tags":["Membership Contracts"],"method":"put","type":"path","servers":["98a02612-1a78-40c2-8320-a479a74f714d"],"security":[],"path":"/api/external/v2/subscription-contract-add-line-item","baseUrlOptions":["https://membership-admin.appstle.com"],"title":"Add product line item to membership contract","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","node","php","go","ruby"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cf13cc78-3ece-4c44-b31e-baeed01305e9":{"description":"Membership contract ID","example":12345,"in":"query","name":"contractId","required":true,"schema":{"format":"int64","type":"integer","isRequired":true,"description":"Membership contract ID","uniqueKey":"","typeLabel":"integer\u003cint64>"}},"72c5b980-2178-4931-b318-25cba5e86fc6":{"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"}},"2e3eb3c0-8d40-4f7d-ad29-c8874755f795":{"in":"header","name":"X-API-Key","required":false,"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"0f285810-1386-4b96-bb67-5df950b364d3":{"description":"Quantity of product to add","example":2,"in":"query","name":"quantity","required":true,"schema":{"format":"int32","type":"integer","isRequired":true,"description":"Quantity of product to add","uniqueKey":"","typeLabel":"integer\u003cint32>"}},"75db0523-695b-419c-8db1-2ae9059e2502":{"description":"Shopify product variant ID (with or without gid:// prefix)","example":"gid://shopify/ProductVariant/987654321","in":"query","name":"variantId","required":true,"schema":{"type":"string","isRequired":true,"description":"Shopify product variant ID (with or without gid:// prefix)","uniqueKey":"","typeLabel":"string"}},"9d886b4a-2ceb-4cc6-9e34-3ec4d7f06451":{"description":"Price per unit in shop's base currency","example":19.99,"in":"query","name":"price","required":true,"schema":{"format":"double","type":"number","isRequired":true,"description":"Price per unit in shop's base currency","uniqueKey":"","typeLabel":"number\u003cdouble>"}}},"responses":{"2109a2a5-a2ba-41ce-9828-87a72feafe50":{"content":{"application/json":{"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":{"additionalInformation":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.additionalInformation.get__typename","typeLabel":"string"},"instructions":{"type":"string","uniqueKey":"deliveryMethod.additionalInformation.instructions","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod.additionalInformation","typeLabel":"object"},"brandedPromise":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.get__typename","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.handle","typeLabel":"string"},"name":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.name","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod.brandedPromise","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"deliveryMethod.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"deliveryMethod.id","typeLabel":"string"},"maxDeliveryDateTime":{"type":"object","uniqueKey":"deliveryMethod.maxDeliveryDateTime","typeLabel":"object"},"methodType":{"enum":["SHIPPING","PICK_UP","NONE","RETAIL","LOCAL","PICKUP_POINT","$UNKNOWN"],"type":"string","uniqueKey":"deliveryMethod.methodType","typeLabel":"enum\u003cstring>"},"minDeliveryDateTime":{"type":"object","uniqueKey":"deliveryMethod.minDeliveryDateTime","typeLabel":"object"},"serviceCode":{"type":"string","uniqueKey":"deliveryMethod.serviceCode","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":{"createdAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].createdAt","typeLabel":"object"},"deliveredAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].deliveredAt","typeLabel":"object"},"displayStatus":{"enum":["ATTEMPTED_DELIVERY","CANCELED","CONFIRMED","DELAYED","DELIVERED","FAILURE","FULFILLED","CARRIER_PICKED_UP","IN_TRANSIT","LABEL_PRINTED","LABEL_PURCHASED","LABEL_VOIDED","MARKED_AS_FULFILLED","NOT_DELIVERED","OUT_FOR_DELIVERY","READY_FOR_PICKUP","PICKED_UP","SUBMITTED","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].displayStatus","typeLabel":"enum\u003cstring>"},"estimatedDeliveryAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].estimatedDeliveryAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].id","typeLabel":"string"},"inTransitAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].inTransitAt","typeLabel":"object"},"name":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].name","typeLabel":"string"},"requiresShipping":{"type":"boolean","uniqueKey":"discounts.nodes.items.[INDEX].requiresShipping","typeLabel":"boolean"},"service":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.get__typename","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.handle","typeLabel":"string"},"serviceName":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.serviceName","typeLabel":"string"},"type":{"enum":["GIFT_CARD","MANUAL","THIRD_PARTY","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].service","typeLabel":"object"},"status":{"enum":["PENDING","OPEN","SUCCESS","CANCELLED","ERROR","FAILURE","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"trackingInfo":{"items":{"properties":{"company":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].company","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].get__typename","typeLabel":"string"},"number":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].number","typeLabel":"string"},"url":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].url","typeLabel":"object"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo","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":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].get__typename","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":{"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].get__typename","typeLabel":"string"}},"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"},"examples":{"Example":{"title":"Example","value":{"billingAttempts":{"get__typename":"\u003cstring>","nodes":[{"completedAt":{},"createdAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","idempotencyKey":"\u003cstring>","ready":true}]},"billingPolicy":{"anchors":[{"cutoffDay":123,"day":123,"get__typename":"\u003cstring>","month":123,"type":"WEEKDAY"}],"get__typename":"\u003cstring>","interval":"DAY","intervalCount":123,"maxCycles":123,"minCycles":123},"createdAt":{},"customAttributes":[{"get__typename":"\u003cstring>","key":"\u003cstring>","value":"\u003cstring>"}],"customer":{"displayName":"\u003cstring>","email":"\u003cstring>","firstName":"\u003cstring>","get__typename":"\u003cstring>","id":"\u003cstring>","lastName":"\u003cstring>","phone":"\u003cstring>"},"customerPaymentMethod":{"get__typename":"\u003cstring>","id":"\u003cstring>","instrument":{"get__typename":"\u003cstring>"},"revokedAt":{},"revokedReason":"AUTHORIZE_NET_GATEWAY_NOT_ENABLED"},"deliveryMethod":{"additionalInformation":{"get__typename":"\u003cstring>","instructions":"\u003cstring>"},"brandedPromise":{"get__typename":"\u003cstring>","handle":"\u003cstring>","name":"\u003cstring>"},"get__typename":"\u003cstring>","id":"\u003cstring>","maxDeliveryDateTime":{},"methodType":"SHIPPING","minDeliveryDateTime":{},"serviceCode":"\u003cstring>"},"deliveryPolicy":{"anchors":[{"cutoffDay":123,"day":123,"get__typename":"\u003cstring>","month":123,"type":"WEEKDAY"}],"get__typename":"\u003cstring>","interval":"DAY","intervalCount":123},"deliveryPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"discounts":{"get__typename":"\u003cstring>","nodes":[{"createdAt":{},"deliveredAt":{},"displayStatus":"ATTEMPTED_DELIVERY","estimatedDeliveryAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","inTransitAt":{},"name":"\u003cstring>","requiresShipping":true,"service":{"get__typename":"\u003cstring>","handle":"\u003cstring>","serviceName":"\u003cstring>","type":"GIFT_CARD"},"status":"PENDING","trackingInfo":[{"company":"\u003cstring>","get__typename":"\u003cstring>","number":"\u003cstring>","url":{}}]}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","lastPaymentStatus":"SUCCEEDED","lines":{"get__typename":"\u003cstring>","nodes":[{"get__typename":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"nextBillingDate":{},"note":"\u003cstring>","originOrder":{"fulfillmentOrders":{"get__typename":"\u003cstring>","nodes":[{"get__typename":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>"},"revisionId":{},"status":"ACTIVE","updatedAt":{}}}},"exampleType":"generated"}},"description":"Line item successfully added to membership contract","exampleType":"generated"},"39246568-f206-40fc-a9d5-2d863187257b":{"content":{"*/*":{"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":{"additionalInformation":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.additionalInformation.get__typename","typeLabel":"string"},"instructions":{"type":"string","uniqueKey":"deliveryMethod.additionalInformation.instructions","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod.additionalInformation","typeLabel":"object"},"brandedPromise":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.get__typename","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.handle","typeLabel":"string"},"name":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.name","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod.brandedPromise","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"deliveryMethod.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"deliveryMethod.id","typeLabel":"string"},"maxDeliveryDateTime":{"type":"object","uniqueKey":"deliveryMethod.maxDeliveryDateTime","typeLabel":"object"},"methodType":{"enum":["SHIPPING","PICK_UP","NONE","RETAIL","LOCAL","PICKUP_POINT","$UNKNOWN"],"type":"string","uniqueKey":"deliveryMethod.methodType","typeLabel":"enum\u003cstring>"},"minDeliveryDateTime":{"type":"object","uniqueKey":"deliveryMethod.minDeliveryDateTime","typeLabel":"object"},"serviceCode":{"type":"string","uniqueKey":"deliveryMethod.serviceCode","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":{"createdAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].createdAt","typeLabel":"object"},"deliveredAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].deliveredAt","typeLabel":"object"},"displayStatus":{"enum":["ATTEMPTED_DELIVERY","CANCELED","CONFIRMED","DELAYED","DELIVERED","FAILURE","FULFILLED","CARRIER_PICKED_UP","IN_TRANSIT","LABEL_PRINTED","LABEL_PURCHASED","LABEL_VOIDED","MARKED_AS_FULFILLED","NOT_DELIVERED","OUT_FOR_DELIVERY","READY_FOR_PICKUP","PICKED_UP","SUBMITTED","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].displayStatus","typeLabel":"enum\u003cstring>"},"estimatedDeliveryAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].estimatedDeliveryAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].id","typeLabel":"string"},"inTransitAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].inTransitAt","typeLabel":"object"},"name":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].name","typeLabel":"string"},"requiresShipping":{"type":"boolean","uniqueKey":"discounts.nodes.items.[INDEX].requiresShipping","typeLabel":"boolean"},"service":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.get__typename","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.handle","typeLabel":"string"},"serviceName":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.serviceName","typeLabel":"string"},"type":{"enum":["GIFT_CARD","MANUAL","THIRD_PARTY","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].service","typeLabel":"object"},"status":{"enum":["PENDING","OPEN","SUCCESS","CANCELLED","ERROR","FAILURE","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"trackingInfo":{"items":{"properties":{"company":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].company","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].get__typename","typeLabel":"string"},"number":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].number","typeLabel":"string"},"url":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].url","typeLabel":"object"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo","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":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].get__typename","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":{"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].get__typename","typeLabel":"string"}},"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"},"examples":{"Example":{"title":"Example","value":{"billingAttempts":{"get__typename":"\u003cstring>","nodes":[{"completedAt":{},"createdAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","idempotencyKey":"\u003cstring>","ready":true}]},"billingPolicy":{"anchors":[{"cutoffDay":123,"day":123,"get__typename":"\u003cstring>","month":123,"type":"WEEKDAY"}],"get__typename":"\u003cstring>","interval":"DAY","intervalCount":123,"maxCycles":123,"minCycles":123},"createdAt":{},"customAttributes":[{"get__typename":"\u003cstring>","key":"\u003cstring>","value":"\u003cstring>"}],"customer":{"displayName":"\u003cstring>","email":"\u003cstring>","firstName":"\u003cstring>","get__typename":"\u003cstring>","id":"\u003cstring>","lastName":"\u003cstring>","phone":"\u003cstring>"},"customerPaymentMethod":{"get__typename":"\u003cstring>","id":"\u003cstring>","instrument":{"get__typename":"\u003cstring>"},"revokedAt":{},"revokedReason":"AUTHORIZE_NET_GATEWAY_NOT_ENABLED"},"deliveryMethod":{"additionalInformation":{"get__typename":"\u003cstring>","instructions":"\u003cstring>"},"brandedPromise":{"get__typename":"\u003cstring>","handle":"\u003cstring>","name":"\u003cstring>"},"get__typename":"\u003cstring>","id":"\u003cstring>","maxDeliveryDateTime":{},"methodType":"SHIPPING","minDeliveryDateTime":{},"serviceCode":"\u003cstring>"},"deliveryPolicy":{"anchors":[{"cutoffDay":123,"day":123,"get__typename":"\u003cstring>","month":123,"type":"WEEKDAY"}],"get__typename":"\u003cstring>","interval":"DAY","intervalCount":123},"deliveryPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"discounts":{"get__typename":"\u003cstring>","nodes":[{"createdAt":{},"deliveredAt":{},"displayStatus":"ATTEMPTED_DELIVERY","estimatedDeliveryAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","inTransitAt":{},"name":"\u003cstring>","requiresShipping":true,"service":{"get__typename":"\u003cstring>","handle":"\u003cstring>","serviceName":"\u003cstring>","type":"GIFT_CARD"},"status":"PENDING","trackingInfo":[{"company":"\u003cstring>","get__typename":"\u003cstring>","number":"\u003cstring>","url":{}}]}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","lastPaymentStatus":"SUCCEEDED","lines":{"get__typename":"\u003cstring>","nodes":[{"get__typename":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"nextBillingDate":{},"note":"\u003cstring>","originOrder":{"fulfillmentOrders":{"get__typename":"\u003cstring>","nodes":[{"get__typename":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>"},"revisionId":{},"status":"ACTIVE","updatedAt":{}}}},"exampleType":"generated"}},"description":"Invalid request - product not found, contract cancelled, or duplicate variant","exampleType":"generated"},"d1598f33-491f-4f9f-be28-eee0a745c82e":{"content":{"*/*":{"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":{"additionalInformation":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.additionalInformation.get__typename","typeLabel":"string"},"instructions":{"type":"string","uniqueKey":"deliveryMethod.additionalInformation.instructions","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod.additionalInformation","typeLabel":"object"},"brandedPromise":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.get__typename","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.handle","typeLabel":"string"},"name":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.name","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod.brandedPromise","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"deliveryMethod.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"deliveryMethod.id","typeLabel":"string"},"maxDeliveryDateTime":{"type":"object","uniqueKey":"deliveryMethod.maxDeliveryDateTime","typeLabel":"object"},"methodType":{"enum":["SHIPPING","PICK_UP","NONE","RETAIL","LOCAL","PICKUP_POINT","$UNKNOWN"],"type":"string","uniqueKey":"deliveryMethod.methodType","typeLabel":"enum\u003cstring>"},"minDeliveryDateTime":{"type":"object","uniqueKey":"deliveryMethod.minDeliveryDateTime","typeLabel":"object"},"serviceCode":{"type":"string","uniqueKey":"deliveryMethod.serviceCode","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":{"createdAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].createdAt","typeLabel":"object"},"deliveredAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].deliveredAt","typeLabel":"object"},"displayStatus":{"enum":["ATTEMPTED_DELIVERY","CANCELED","CONFIRMED","DELAYED","DELIVERED","FAILURE","FULFILLED","CARRIER_PICKED_UP","IN_TRANSIT","LABEL_PRINTED","LABEL_PURCHASED","LABEL_VOIDED","MARKED_AS_FULFILLED","NOT_DELIVERED","OUT_FOR_DELIVERY","READY_FOR_PICKUP","PICKED_UP","SUBMITTED","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].displayStatus","typeLabel":"enum\u003cstring>"},"estimatedDeliveryAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].estimatedDeliveryAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].id","typeLabel":"string"},"inTransitAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].inTransitAt","typeLabel":"object"},"name":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].name","typeLabel":"string"},"requiresShipping":{"type":"boolean","uniqueKey":"discounts.nodes.items.[INDEX].requiresShipping","typeLabel":"boolean"},"service":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.get__typename","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.handle","typeLabel":"string"},"serviceName":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.serviceName","typeLabel":"string"},"type":{"enum":["GIFT_CARD","MANUAL","THIRD_PARTY","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].service","typeLabel":"object"},"status":{"enum":["PENDING","OPEN","SUCCESS","CANCELLED","ERROR","FAILURE","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"trackingInfo":{"items":{"properties":{"company":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].company","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].get__typename","typeLabel":"string"},"number":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].number","typeLabel":"string"},"url":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].url","typeLabel":"object"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo","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":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].get__typename","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":{"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].get__typename","typeLabel":"string"}},"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"},"examples":{"Example":{"title":"Example","value":{"billingAttempts":{"get__typename":"\u003cstring>","nodes":[{"completedAt":{},"createdAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","idempotencyKey":"\u003cstring>","ready":true}]},"billingPolicy":{"anchors":[{"cutoffDay":123,"day":123,"get__typename":"\u003cstring>","month":123,"type":"WEEKDAY"}],"get__typename":"\u003cstring>","interval":"DAY","intervalCount":123,"maxCycles":123,"minCycles":123},"createdAt":{},"customAttributes":[{"get__typename":"\u003cstring>","key":"\u003cstring>","value":"\u003cstring>"}],"customer":{"displayName":"\u003cstring>","email":"\u003cstring>","firstName":"\u003cstring>","get__typename":"\u003cstring>","id":"\u003cstring>","lastName":"\u003cstring>","phone":"\u003cstring>"},"customerPaymentMethod":{"get__typename":"\u003cstring>","id":"\u003cstring>","instrument":{"get__typename":"\u003cstring>"},"revokedAt":{},"revokedReason":"AUTHORIZE_NET_GATEWAY_NOT_ENABLED"},"deliveryMethod":{"additionalInformation":{"get__typename":"\u003cstring>","instructions":"\u003cstring>"},"brandedPromise":{"get__typename":"\u003cstring>","handle":"\u003cstring>","name":"\u003cstring>"},"get__typename":"\u003cstring>","id":"\u003cstring>","maxDeliveryDateTime":{},"methodType":"SHIPPING","minDeliveryDateTime":{},"serviceCode":"\u003cstring>"},"deliveryPolicy":{"anchors":[{"cutoffDay":123,"day":123,"get__typename":"\u003cstring>","month":123,"type":"WEEKDAY"}],"get__typename":"\u003cstring>","interval":"DAY","intervalCount":123},"deliveryPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"discounts":{"get__typename":"\u003cstring>","nodes":[{"createdAt":{},"deliveredAt":{},"displayStatus":"ATTEMPTED_DELIVERY","estimatedDeliveryAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","inTransitAt":{},"name":"\u003cstring>","requiresShipping":true,"service":{"get__typename":"\u003cstring>","handle":"\u003cstring>","serviceName":"\u003cstring>","type":"GIFT_CARD"},"status":"PENDING","trackingInfo":[{"company":"\u003cstring>","get__typename":"\u003cstring>","number":"\u003cstring>","url":{}}]}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","lastPaymentStatus":"SUCCEEDED","lines":{"get__typename":"\u003cstring>","nodes":[{"get__typename":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"nextBillingDate":{},"note":"\u003cstring>","originOrder":{"fulfillmentOrders":{"get__typename":"\u003cstring>","nodes":[{"get__typename":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>"},"revisionId":{},"status":"ACTIVE","updatedAt":{}}}},"exampleType":"generated"}},"description":"Authentication required - invalid or missing API key","exampleType":"generated"},"c231e957-80e4-4bdc-9ece-f9c63f8bf1a4":{"content":{"*/*":{"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":{"additionalInformation":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.additionalInformation.get__typename","typeLabel":"string"},"instructions":{"type":"string","uniqueKey":"deliveryMethod.additionalInformation.instructions","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod.additionalInformation","typeLabel":"object"},"brandedPromise":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.get__typename","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.handle","typeLabel":"string"},"name":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.name","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod.brandedPromise","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"deliveryMethod.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"deliveryMethod.id","typeLabel":"string"},"maxDeliveryDateTime":{"type":"object","uniqueKey":"deliveryMethod.maxDeliveryDateTime","typeLabel":"object"},"methodType":{"enum":["SHIPPING","PICK_UP","NONE","RETAIL","LOCAL","PICKUP_POINT","$UNKNOWN"],"type":"string","uniqueKey":"deliveryMethod.methodType","typeLabel":"enum\u003cstring>"},"minDeliveryDateTime":{"type":"object","uniqueKey":"deliveryMethod.minDeliveryDateTime","typeLabel":"object"},"serviceCode":{"type":"string","uniqueKey":"deliveryMethod.serviceCode","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":{"createdAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].createdAt","typeLabel":"object"},"deliveredAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].deliveredAt","typeLabel":"object"},"displayStatus":{"enum":["ATTEMPTED_DELIVERY","CANCELED","CONFIRMED","DELAYED","DELIVERED","FAILURE","FULFILLED","CARRIER_PICKED_UP","IN_TRANSIT","LABEL_PRINTED","LABEL_PURCHASED","LABEL_VOIDED","MARKED_AS_FULFILLED","NOT_DELIVERED","OUT_FOR_DELIVERY","READY_FOR_PICKUP","PICKED_UP","SUBMITTED","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].displayStatus","typeLabel":"enum\u003cstring>"},"estimatedDeliveryAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].estimatedDeliveryAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].id","typeLabel":"string"},"inTransitAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].inTransitAt","typeLabel":"object"},"name":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].name","typeLabel":"string"},"requiresShipping":{"type":"boolean","uniqueKey":"discounts.nodes.items.[INDEX].requiresShipping","typeLabel":"boolean"},"service":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.get__typename","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.handle","typeLabel":"string"},"serviceName":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.serviceName","typeLabel":"string"},"type":{"enum":["GIFT_CARD","MANUAL","THIRD_PARTY","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].service","typeLabel":"object"},"status":{"enum":["PENDING","OPEN","SUCCESS","CANCELLED","ERROR","FAILURE","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"trackingInfo":{"items":{"properties":{"company":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].company","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].get__typename","typeLabel":"string"},"number":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].number","typeLabel":"string"},"url":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].url","typeLabel":"object"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo","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":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].get__typename","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":{"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].get__typename","typeLabel":"string"}},"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"},"examples":{"Example":{"title":"Example","value":{"billingAttempts":{"get__typename":"\u003cstring>","nodes":[{"completedAt":{},"createdAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","idempotencyKey":"\u003cstring>","ready":true}]},"billingPolicy":{"anchors":[{"cutoffDay":123,"day":123,"get__typename":"\u003cstring>","month":123,"type":"WEEKDAY"}],"get__typename":"\u003cstring>","interval":"DAY","intervalCount":123,"maxCycles":123,"minCycles":123},"createdAt":{},"customAttributes":[{"get__typename":"\u003cstring>","key":"\u003cstring>","value":"\u003cstring>"}],"customer":{"displayName":"\u003cstring>","email":"\u003cstring>","firstName":"\u003cstring>","get__typename":"\u003cstring>","id":"\u003cstring>","lastName":"\u003cstring>","phone":"\u003cstring>"},"customerPaymentMethod":{"get__typename":"\u003cstring>","id":"\u003cstring>","instrument":{"get__typename":"\u003cstring>"},"revokedAt":{},"revokedReason":"AUTHORIZE_NET_GATEWAY_NOT_ENABLED"},"deliveryMethod":{"additionalInformation":{"get__typename":"\u003cstring>","instructions":"\u003cstring>"},"brandedPromise":{"get__typename":"\u003cstring>","handle":"\u003cstring>","name":"\u003cstring>"},"get__typename":"\u003cstring>","id":"\u003cstring>","maxDeliveryDateTime":{},"methodType":"SHIPPING","minDeliveryDateTime":{},"serviceCode":"\u003cstring>"},"deliveryPolicy":{"anchors":[{"cutoffDay":123,"day":123,"get__typename":"\u003cstring>","month":123,"type":"WEEKDAY"}],"get__typename":"\u003cstring>","interval":"DAY","intervalCount":123},"deliveryPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"discounts":{"get__typename":"\u003cstring>","nodes":[{"createdAt":{},"deliveredAt":{},"displayStatus":"ATTEMPTED_DELIVERY","estimatedDeliveryAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","inTransitAt":{},"name":"\u003cstring>","requiresShipping":true,"service":{"get__typename":"\u003cstring>","handle":"\u003cstring>","serviceName":"\u003cstring>","type":"GIFT_CARD"},"status":"PENDING","trackingInfo":[{"company":"\u003cstring>","get__typename":"\u003cstring>","number":"\u003cstring>","url":{}}]}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","lastPaymentStatus":"SUCCEEDED","lines":{"get__typename":"\u003cstring>","nodes":[{"get__typename":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"nextBillingDate":{},"note":"\u003cstring>","originOrder":{"fulfillmentOrders":{"get__typename":"\u003cstring>","nodes":[{"get__typename":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>"},"revisionId":{},"status":"ACTIVE","updatedAt":{}}}},"exampleType":"generated"}},"description":"Forbidden - contract does not belong to authenticated shop","exampleType":"generated"},"c0e510c6-449e-4c0e-b8e4-3eedb5fb495b":{"content":{"*/*":{"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":{"additionalInformation":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.additionalInformation.get__typename","typeLabel":"string"},"instructions":{"type":"string","uniqueKey":"deliveryMethod.additionalInformation.instructions","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod.additionalInformation","typeLabel":"object"},"brandedPromise":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.get__typename","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.handle","typeLabel":"string"},"name":{"type":"string","uniqueKey":"deliveryMethod.brandedPromise.name","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod.brandedPromise","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"deliveryMethod.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"deliveryMethod.id","typeLabel":"string"},"maxDeliveryDateTime":{"type":"object","uniqueKey":"deliveryMethod.maxDeliveryDateTime","typeLabel":"object"},"methodType":{"enum":["SHIPPING","PICK_UP","NONE","RETAIL","LOCAL","PICKUP_POINT","$UNKNOWN"],"type":"string","uniqueKey":"deliveryMethod.methodType","typeLabel":"enum\u003cstring>"},"minDeliveryDateTime":{"type":"object","uniqueKey":"deliveryMethod.minDeliveryDateTime","typeLabel":"object"},"serviceCode":{"type":"string","uniqueKey":"deliveryMethod.serviceCode","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":{"createdAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].createdAt","typeLabel":"object"},"deliveredAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].deliveredAt","typeLabel":"object"},"displayStatus":{"enum":["ATTEMPTED_DELIVERY","CANCELED","CONFIRMED","DELAYED","DELIVERED","FAILURE","FULFILLED","CARRIER_PICKED_UP","IN_TRANSIT","LABEL_PRINTED","LABEL_PURCHASED","LABEL_VOIDED","MARKED_AS_FULFILLED","NOT_DELIVERED","OUT_FOR_DELIVERY","READY_FOR_PICKUP","PICKED_UP","SUBMITTED","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].displayStatus","typeLabel":"enum\u003cstring>"},"estimatedDeliveryAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].estimatedDeliveryAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].id","typeLabel":"string"},"inTransitAt":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].inTransitAt","typeLabel":"object"},"name":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].name","typeLabel":"string"},"requiresShipping":{"type":"boolean","uniqueKey":"discounts.nodes.items.[INDEX].requiresShipping","typeLabel":"boolean"},"service":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.get__typename","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.handle","typeLabel":"string"},"serviceName":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.serviceName","typeLabel":"string"},"type":{"enum":["GIFT_CARD","MANUAL","THIRD_PARTY","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].service.type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].service","typeLabel":"object"},"status":{"enum":["PENDING","OPEN","SUCCESS","CANCELLED","ERROR","FAILURE","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"trackingInfo":{"items":{"properties":{"company":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].company","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].get__typename","typeLabel":"string"},"number":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].number","typeLabel":"string"},"url":{"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX].url","typeLabel":"object"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"discounts.nodes.items.[INDEX].trackingInfo","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":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].get__typename","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":{"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].get__typename","typeLabel":"string"}},"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"},"examples":{"Example":{"title":"Example","value":{"billingAttempts":{"get__typename":"\u003cstring>","nodes":[{"completedAt":{},"createdAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","idempotencyKey":"\u003cstring>","ready":true}]},"billingPolicy":{"anchors":[{"cutoffDay":123,"day":123,"get__typename":"\u003cstring>","month":123,"type":"WEEKDAY"}],"get__typename":"\u003cstring>","interval":"DAY","intervalCount":123,"maxCycles":123,"minCycles":123},"createdAt":{},"customAttributes":[{"get__typename":"\u003cstring>","key":"\u003cstring>","value":"\u003cstring>"}],"customer":{"displayName":"\u003cstring>","email":"\u003cstring>","firstName":"\u003cstring>","get__typename":"\u003cstring>","id":"\u003cstring>","lastName":"\u003cstring>","phone":"\u003cstring>"},"customerPaymentMethod":{"get__typename":"\u003cstring>","id":"\u003cstring>","instrument":{"get__typename":"\u003cstring>"},"revokedAt":{},"revokedReason":"AUTHORIZE_NET_GATEWAY_NOT_ENABLED"},"deliveryMethod":{"additionalInformation":{"get__typename":"\u003cstring>","instructions":"\u003cstring>"},"brandedPromise":{"get__typename":"\u003cstring>","handle":"\u003cstring>","name":"\u003cstring>"},"get__typename":"\u003cstring>","id":"\u003cstring>","maxDeliveryDateTime":{},"methodType":"SHIPPING","minDeliveryDateTime":{},"serviceCode":"\u003cstring>"},"deliveryPolicy":{"anchors":[{"cutoffDay":123,"day":123,"get__typename":"\u003cstring>","month":123,"type":"WEEKDAY"}],"get__typename":"\u003cstring>","interval":"DAY","intervalCount":123},"deliveryPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"discounts":{"get__typename":"\u003cstring>","nodes":[{"createdAt":{},"deliveredAt":{},"displayStatus":"ATTEMPTED_DELIVERY","estimatedDeliveryAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","inTransitAt":{},"name":"\u003cstring>","requiresShipping":true,"service":{"get__typename":"\u003cstring>","handle":"\u003cstring>","serviceName":"\u003cstring>","type":"GIFT_CARD"},"status":"PENDING","trackingInfo":[{"company":"\u003cstring>","get__typename":"\u003cstring>","number":"\u003cstring>","url":{}}]}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","lastPaymentStatus":"SUCCEEDED","lines":{"get__typename":"\u003cstring>","nodes":[{"get__typename":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"nextBillingDate":{},"note":"\u003cstring>","originOrder":{"fulfillmentOrders":{"get__typename":"\u003cstring>","nodes":[{"get__typename":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>"},"revisionId":{},"status":"ACTIVE","updatedAt":{}}}},"exampleType":"generated"}},"description":"Membership contract or product variant not found","exampleType":"generated"}},"security":{},"servers":{"98a02612-1a78-40c2-8320-a479a74f714d":{"url":"https://membership-admin.appstle.com"}}},"originalFileLocation":"memberships/admin-api-swagger.json"},"subdomain":"appstleinc-aeca3e0a","siteName":"Appstle","title":"Add product line item to membership contract - Appstle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-06T07:00:43.635Z","originalFileLocation":"memberships-admin-api/membership-contracts/add-product-line-item-to-membership-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=\"Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders. Key Features: - Add Products: Include new products in future membership deliveries - Quantity Control: Specify how many units of the product to add - Price Override: Set custom pricing for the added product - Immediate Effect: Changes apply to next billing cycle - Activity Logging: All additions are tracked in activity logs Required Parameters: - contractId: Membership contract ID to modify - variantId: Shopify product variant ID (with gid:// prefix or numeric) - quantity: Number of units to add (must be positive integer) - price: Price per unit in shop\u0026#x27;s base currency Product Variant ID Format: Accepts two formats: - Shopify GID: gid://shopify/ProductVariant/12345678901 - Numeric ID: 12345678901 Price Behavior: - Price is per unit, not total - Must be in shop\u0026#x27;s base currency (USD, EUR, etc.) - Can override product\u0026#x27;s default price - Does not include taxes or shipping - Total line item cost = price × quantity Line Item Addition Rules: - Product variant must exist in Shopify catalog - Product must be active and available - Variant must have sufficient inventory (if tracked) - Contract must be ACTIVE or PAUSED (not CANCELLED) - Cannot add duplicate variants (use update quantity instead) Common Use Cases: - Customer adds complementary product to existing membership - Upsell additional products through customer portal - Merchant adds bonus items to customer memberships - Build custom \u0026quot;add-on\u0026quot; product selection interfaces - Cross-sell related products to existing subscribers - Create bundle upgrades (add multiple products at once) Post-Addition Effects: - Next billing amount increases by (price × quantity) - Product appears in all future membership deliveries - Customer receives confirmation of membership update - Activity log records the addition with source (portal/merchant) - Contract\u0026#x27;s next billing date remains unchanged Integration Example: PUT /api/external/v2/subscription-contract-add-line-item? contractId=123456\u0026amp; variantId=gid://shopify/ProductVariant/987654321\u0026amp; quantity=2\u0026amp; price=19.99 This adds 2 units of variant 987654321 at $19.99 each ($39.98 total) to contract 123456. Important Notes: - Changes apply to NEXT billing cycle, not current/past orders - If product is out of stock, order may be delayed or skipped - Price changes don\u0026#x27;t affect historical orders - Consider inventory availability before adding products Authentication: Requires API key authentication via X-API-Key header or api_key parameter\">\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=\"Add product line item to membership contract - Appstle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders. Key Features: - Add Products: Include new products in future membership deliveries - Quantity Control: Specify how many units of the product to add - Price Override: Set custom pricing for the added product - Immediate Effect: Changes apply to next billing cycle - Activity Logging: All additions are tracked in activity logs Required Parameters: - contractId: Membership contract ID to modify - variantId: Shopify product variant ID (with gid:// prefix or numeric) - quantity: Number of units to add (must be positive integer) - price: Price per unit in shop\u0026#x27;s base currency Product Variant ID Format: Accepts two formats: - Shopify GID: gid://shopify/ProductVariant/12345678901 - Numeric ID: 12345678901 Price Behavior: - Price is per unit, not total - Must be in shop\u0026#x27;s base currency (USD, EUR, etc.) - Can override product\u0026#x27;s default price - Does not include taxes or shipping - Total line item cost = price × quantity Line Item Addition Rules: - Product variant must exist in Shopify catalog - Product must be active and available - Variant must have sufficient inventory (if tracked) - Contract must be ACTIVE or PAUSED (not CANCELLED) - Cannot add duplicate variants (use update quantity instead) Common Use Cases: - Customer adds complementary product to existing membership - Upsell additional products through customer portal - Merchant adds bonus items to customer memberships - Build custom \u0026quot;add-on\u0026quot; product selection interfaces - Cross-sell related products to existing subscribers - Create bundle upgrades (add multiple products at once) Post-Addition Effects: - Next billing amount increases by (price × quantity) - Product appears in all future membership deliveries - Customer receives confirmation of membership update - Activity log records the addition with source (portal/merchant) - Contract\u0026#x27;s next billing date remains unchanged Integration Example: PUT /api/external/v2/subscription-contract-add-line-item? contractId=123456\u0026amp; variantId=gid://shopify/ProductVariant/987654321\u0026amp; quantity=2\u0026amp; price=19.99 This adds 2 units of variant 987654321 at $19.99 each ($39.98 total) to contract 123456. Important Notes: - Changes apply to NEXT billing cycle, not current/past orders - If product is out of stock, order may be delayed or skipped - Price changes don\u0026#x27;t affect historical orders - Consider inventory availability before adding products Authentication: Requires API key authentication via X-API-Key header or api_key parameter\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Appstle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.appstle.com/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://appstleinc-aeca3e0a.mintlify.app/_mintlify/api/og/v2?division=Membership+Contracts\u0026amp;title=Add+product+line+item+to+membership+contract\u0026amp;description=Adds+a+new+product+%28line+item%29+to+an+existing+membership+contract.+This+allows+customers+or+merchants+to+add+products+to+their+recurring+membership+orders.%0A%0A**K\u0026amp;theme=f3911f4da205a97f19a260f1\u0026amp;signature=c1a5c49c6d37f92df5ad3cb2263c65c1f06946e07f66df35b78755c9af06f0d6\">\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=\"Add product line item to membership contract - Appstle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders. Key Features: - Add Products: Include new products in future membership deliveries - Quantity Control: Specify how many units of the product to add - Price Override: Set custom pricing for the added product - Immediate Effect: Changes apply to next billing cycle - Activity Logging: All additions are tracked in activity logs Required Parameters: - contractId: Membership contract ID to modify - variantId: Shopify product variant ID (with gid:// prefix or numeric) - quantity: Number of units to add (must be positive integer) - price: Price per unit in shop\u0026#x27;s base currency Product Variant ID Format: Accepts two formats: - Shopify GID: gid://shopify/ProductVariant/12345678901 - Numeric ID: 12345678901 Price Behavior: - Price is per unit, not total - Must be in shop\u0026#x27;s base currency (USD, EUR, etc.) - Can override product\u0026#x27;s default price - Does not include taxes or shipping - Total line item cost = price × quantity Line Item Addition Rules: - Product variant must exist in Shopify catalog - Product must be active and available - Variant must have sufficient inventory (if tracked) - Contract must be ACTIVE or PAUSED (not CANCELLED) - Cannot add duplicate variants (use update quantity instead) Common Use Cases: - Customer adds complementary product to existing membership - Upsell additional products through customer portal - Merchant adds bonus items to customer memberships - Build custom \u0026quot;add-on\u0026quot; product selection interfaces - Cross-sell related products to existing subscribers - Create bundle upgrades (add multiple products at once) Post-Addition Effects: - Next billing amount increases by (price × quantity) - Product appears in all future membership deliveries - Customer receives confirmation of membership update - Activity log records the addition with source (portal/merchant) - Contract\u0026#x27;s next billing date remains unchanged Integration Example: PUT /api/external/v2/subscription-contract-add-line-item? contractId=123456\u0026amp; variantId=gid://shopify/ProductVariant/987654321\u0026amp; quantity=2\u0026amp; price=19.99 This adds 2 units of variant 987654321 at $19.99 each ($39.98 total) to contract 123456. Important Notes: - Changes apply to NEXT billing cycle, not current/past orders - If product is out of stock, order may be delayed or skipped - Price changes don\u0026#x27;t affect historical orders - Consider inventory availability before adding products Authentication: Requires API key authentication via X-API-Key header or api_key parameter\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://appstleinc-aeca3e0a.mintlify.app/_mintlify/api/og/v2?division=Membership+Contracts\u0026amp;title=Add+product+line+item+to+membership+contract\u0026amp;description=Adds+a+new+product+%28line+item%29+to+an+existing+membership+contract.+This+allows+customers+or+merchants+to+add+products+to+their+recurring+membership+orders.%0A%0A**K\u0026amp;theme=f3911f4da205a97f19a260f1\u0026amp;signature=c1a5c49c6d37f92df5ad3cb2263c65c1f06946e07f66df35b78755c9af06f0d6\">\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/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-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/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract#webpage\",\"url\":\"https://developers.appstle.com/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract\",\"name\":\"Add product line item to membership contract\",\"description\":\"Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders. Key Features: - Add Products: Include new products in future membership deliveries - Quantity Control: Specify how many units of the product to add - Price Override: Set custom pricing for the added product - Immediate Effect: Changes apply to next billing cycle - Activity Logging: All additions are tracked in activity logs Required Parameters: - contractId: Membership contract ID to modify - variantId: Shopify product variant ID (with gid:// prefix or numeric) - quantity: Number of units to add (must be positive integer) - price: Price per unit in shop's base currency Product Variant ID Format: Accepts two formats: - Shopify GID: gid://shopify/ProductVariant/12345678901 - Numeric ID: 12345678901 Price Behavior: - Price is per unit, not total - Must be in shop's base currency (USD, EUR, etc.) - Can override product's default price - Does not include taxes or shipping - Total line item cost = price × quantity Line Item Addition Rules: - Product variant must exist in Shopify catalog - Product must be active and available - Variant must have sufficient inventory (if tracked) - Contract must be ACTIVE or PAUSED (not CANCELLED) - Cannot add duplicate variants (use update quantity instead) Common Use Cases: - Customer adds complementary product to existing membership - Upsell additional products through customer portal - Merchant adds bonus items to customer memberships - Build custom \\\"add-on\\\" product selection interfaces - Cross-sell related products to existing subscribers - Create bundle upgrades (add multiple products at once) Post-Addition Effects: - Next billing amount increases by (price × quantity) - Product appears in all future membership deliveries - Customer receives confirmation of membership update - Activity log records the addition with source (portal/merchant) - Contract's next billing date remains unchanged Integration Example: PUT /api/external/v2/subscription-contract-add-line-item? contractId=123456\u0026 variantId=gid://shopify/ProductVariant/987654321\u0026 quantity=2\u0026 price=19.99 This adds 2 units of variant 987654321 at $19.99 each ($39.98 total) to contract 123456. Important Notes: - Changes apply to NEXT billing cycle, not current/past orders - If product is out of stock, order may be delayed or skipped - Price changes don't affect historical orders - Consider inventory availability before adding products Authentication: Requires API key authentication via X-API-Key header or api_key parameter\",\"dateModified\":\"2026-09-06T07:00:43.635Z\",\"isPartOf\":{\"@id\":\"https://developers.appstle.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.appstle.com/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.appstle.com/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Admin API\",\"item\":\"https://developers.appstle.com/memberships-admin-api/cancellation-flow-configuration/get-cancellation-flow-configuration\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Membership Contracts\",\"item\":\"https://developers.appstle.com/memberships-admin-api/membership-contracts/generate-customer-portal-authentication-token\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add product line item to membership contract\",\"item\":\"https://developers.appstle.com/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.appstle.com/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract#apireference\",\"headline\":\"Add product line item to membership contract\",\"name\":\"Add product line item to membership contract\",\"description\":\"Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders. Key Features: - Add Products: Include new products in future membership deliveries - Quantity Control: Specify how many units of the product to add - Price Override: Set custom pricing for the added product - Immediate Effect: Changes apply to next billing cycle - Activity Logging: All additions are tracked in activity logs Required Parameters: - contractId: Membership contract ID to modify - variantId: Shopify product variant ID (with gid:// prefix or numeric) - quantity: Number of units to add (must be positive integer) - price: Price per unit in shop's base currency Product Variant ID Format: Accepts two formats: - Shopify GID: gid://shopify/ProductVariant/12345678901 - Numeric ID: 12345678901 Price Behavior: - Price is per unit, not total - Must be in shop's base currency (USD, EUR, etc.) - Can override product's default price - Does not include taxes or shipping - Total line item cost = price × quantity Line Item Addition Rules: - Product variant must exist in Shopify catalog - Product must be active and available - Variant must have sufficient inventory (if tracked) - Contract must be ACTIVE or PAUSED (not CANCELLED) - Cannot add duplicate variants (use update quantity instead) Common Use Cases: - Customer adds complementary product to existing membership - Upsell additional products through customer portal - Merchant adds bonus items to customer memberships - Build custom \\\"add-on\\\" product selection interfaces - Cross-sell related products to existing subscribers - Create bundle upgrades (add multiple products at once) Post-Addition Effects: - Next billing amount increases by (price × quantity) - Product appears in all future membership deliveries - Customer receives confirmation of membership update - Activity log records the addition with source (portal/merchant) - Contract's next billing date remains unchanged Integration Example: PUT /api/external/v2/subscription-contract-add-line-item? contractId=123456\u0026 variantId=gid://shopify/ProductVariant/987654321\u0026 quantity=2\u0026 price=19.99 This adds 2 units of variant 987654321 at $19.99 each ($39.98 total) to contract 123456. Important Notes: - Changes apply to NEXT billing cycle, not current/past orders - If product is out of stock, order may be delayed or skipped - Price changes don't affect historical orders - Consider inventory availability before adding products Authentication: Requires API key authentication via X-API-Key header or api_key parameter\",\"url\":\"https://developers.appstle.com/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract\",\"mainEntityOfPage\":{\"@id\":\"https://developers.appstle.com/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract#webpage\"},\"dateModified\":\"2026-09-06T07:00:43.635Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Appstle","nav":{"global":null,"products":[{"product":"Subscriptions","icon":"arrows-rotate","description":"Recurring orders, selling plans, and the customer portal","pages":[{"title":"Subscriptions","href":"/subscription/introduction"}]},{"product":"Loyalty","icon":"medal","description":"Points, VIP tiers, rewards, referrals, and store credit","pages":[{"title":"Loyalty","href":"/loyalty/introduction"}]},{"product":"Memberships","icon":"id-card","description":"Membership plans, member perks, billing, and access control","groups":[{"group":"Get Started","pages":[{"title":"Appstle Memberships: Tiered Plans \u0026 Access Control","sidebarTitle":"Introduction","href":"/memberships/introduction"},{"title":"Authenticate with the Appstle Memberships API","sidebarTitle":"Authentication","href":"/memberships/authentication"},{"title":"Get started with Appstle Memberships API","sidebarTitle":"Quickstart","href":"/memberships/quickstart"}]},{"group":"Guides","pages":[{"title":"Appstle Memberships third-party integration guide","sidebarTitle":"Integration guide","href":"/memberships/integration-guide"},{"title":"Automate memberships with Shopify Flow","sidebarTitle":"Shopify Flow","href":"/memberships/shopify-flow"},{"title":"Shopify metafields and tags for Appstle Memberships","sidebarTitle":"Metafields \u0026 tags","href":"/memberships/metafields-and-tags"}]},{"group":"Partner Integration","pages":[{"title":"Partner Integration Framework overview","sidebarTitle":"Framework overview","href":"/memberships/partner-framework-overview"},{"title":"Partner Integration Framework","sidebarTitle":"Partner integration","href":"/memberships/partner-integration"}]},{"group":"Webhooks","pages":[{"title":"Appstle Memberships webhook events and setup","sidebarTitle":"Webhooks","href":"/memberships/webhooks"}]},{"group":"Admin API","pages":[{"group":"Cancellation Flow Configuration","pages":[{"title":"Get cancellation flow configuration","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/cancellation-managements/{id}","href":"/memberships-admin-api/cancellation-flow-configuration/get-cancellation-flow-configuration"}]},{"group":"Customer Discount History","pages":[{"title":"Get past discount codes for contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/customer-discount-code-infos/get-past-discounts","href":"/memberships-admin-api/customer-discount-history/get-past-discount-codes-for-contract"}]},{"group":"Customer Payment Methods","pages":[{"title":"Get customer payment token information","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/customer-payments/token/{customerId}","href":"/memberships-admin-api/customer-payment-methods/get-customer-payment-token-information"}]},{"group":"Customer Portal Configuration","pages":[{"title":"Get customer portal settings","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/customer-portal-settings/{id}","href":"/memberships-admin-api/customer-portal-configuration/get-customer-portal-settings"}]},{"group":"Membership Contracts","pages":[{"title":"Generate customer portal authentication token","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/customer-portal-token","href":"/memberships-admin-api/membership-contracts/generate-customer-portal-authentication-token"},{"title":"Generate customer portal magic link","description":"Generates a secure, time-limited magic link that allows customers to access and manage their memberships. This passwordless authentication link directs customers to the membership management portal.\n\n**Magic Link Features:**\n- **Passwordless Access**: No login credentials required, link serves as authentication\n- **Time-Limited**: Link expires after configured duration (typically 24-72 hours)\n- **Single Customer**: Link is bound to specific customer ID, cannot be reused for others\n- **Secure Token**: Uses cryptographically secure JWT tokens for authentication\n- **Customer Portal**: Directs to full-featured self-service membership portal\n\n**Returned Information:**\n- **Magic Link URL**: Full URL to customer portal with embedded authentication token\n- **Token**: JWT token value (can be used separately if needed)\n- **Expiration Time**: When the magic link will expire (ISO 8601 format)\n- **Customer ID**: Shopify customer ID the link is generated for\n- **Shop Domain**: Store domain where memberships are hosted\n\n**Customer Portal Capabilities (via Magic Link):**\n- View all active and paused membership contracts\n- Update shipping address for upcoming deliveries\n- Change payment method for future billing\n- Pause or resume membership deliveries\n- Skip upcoming delivery orders\n- Modify delivery frequency (e.g., monthly to bi-monthly)\n- Add or remove products from membership\n- Swap product variants (size, flavor, color)\n- Cancel membership with reason feedback\n- View order history and upcoming deliveries\n- Apply discount codes to membership\n\n**Common Use Cases:**\n- Send magic link via email for customer self-service\n- Include link in transactional emails (order confirmation, shipping notices)\n- Customer support: provide link to customers over phone/chat\n- Embed link in customer account page or dashboard\n- Automated email campaigns for membership management reminders\n- Post-purchase flows to encourage membership modifications\n- Win-back campaigns: send magic link to cancelled/paused customers\n\n**Security Notes:**\n- Links are single-use per session (new token generated each time)\n- Tokens include shop and customer validation to prevent tampering\n- Expired links automatically redirect to token request page\n- Links should be sent via secure channels (HTTPS, encrypted email)\n\n**Integration Best Practices:**\n- Always send magic links via email or SMS (don't display on public pages)\n- Set appropriate expiration time based on use case\n- Include clear call-to-action in emails (\"Manage Your Membership\")\n- Handle expired tokens gracefully with re-send functionality\n- Track magic link generation for security audit logs\n\n**Authentication:** Requires API key authentication via X-API-Key header or api_key parameter","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/manage-subscription-link/{customerId}","href":"/memberships-admin-api/membership-contracts/generate-customer-portal-magic-link"},{"title":"Add product line item to membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contract-add-line-item","href":"/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract"},{"title":"Get membership contract list","description":"Retrieves a paginated list of membership contracts with advanced filtering capabilities. This endpoint provides comprehensive access to all membership contracts in your store with flexible query options.\n\n**Key Information Returned:**\n- **Contract Details**: Contract ID, status, creation date, billing cycle\n- **Customer Information**: Customer name, email, Shopify customer ID\n- **Membership Items**: Products, variants, quantities in membership\n- **Billing Information**: Next billing date, billing frequency, pricing\n- **Delivery Details**: Shipping address, delivery method, next delivery date\n- **Plan Information**: Membership plan type, selling plan IDs\n- **Status Tracking**: Active, paused, cancelled, expired states\n\n**Filtering Capabilities:**\n- **Date Ranges**: Filter by creation date or next billing date\n- **Customer Search**: Search by customer name or email\n- **Status Filter**: Filter by contract status (active, paused, cancelled)\n- **Plan Type**: Filter by membership plan type\n- **Billing Frequency**: Filter by billing interval (weekly, monthly, etc.)\n- **Product/Variant**: Find contracts containing specific products or variants\n- **Order Name**: Search by Shopify order name/number\n- **Selling Plan**: Filter by Shopify selling plan IDs\n- **Special Filters**: Contracts with deleted products or bounced emails\n\n**Pagination:**\n- Supports standard pagination parameters (page, size, sort)\n- Returns pagination headers for total count and navigation\n- Default page size configurable via request parameters\n\n**Use Cases:**\n- Export membership data to external CRM or analytics systems\n- Build custom membership dashboards and reports\n- Sync membership data with external platforms\n- Identify memberships needing attention (bounced emails, deleted products)\n- Generate membership activity reports by date range\n- Find all memberships for a specific product or variant\n- Monitor membership health and churn metrics\n\n**Authentication:** Requires API key authentication via X-API-Key header or api_key parameter","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-contract-details","href":"/memberships-admin-api/membership-contracts/get-membership-contract-list"},{"title":"Get billing interval options for selling plans","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-contract-details/billing-interval","href":"/memberships-admin-api/membership-contracts/get-billing-interval-options-for-selling-plans"},{"title":"Get customer payment methods","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-contract-details/shopify/customer/{customerId}/payment-methods","href":"/memberships-admin-api/membership-contracts/get-customer-payment-methods"},{"title":"Get membership order fulfillment details","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-contract-details/subscription-fulfillments/{contractId}","href":"/memberships-admin-api/membership-contracts/get-membership-order-fulfillment-details"},{"title":"Get pending downgrade for a membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-contract-details/{contractId}/pending-downgrade","href":"/memberships-admin-api/membership-contracts/get-pending-downgrade-for-a-membership-contract"},{"title":"Cancel pending downgrade for a membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json delete /api/external/v2/subscription-contract-details/{contractId}/pending-downgrade","href":"/memberships-admin-api/membership-contracts/cancel-pending-downgrade-for-a-membership-contract"},{"title":"Update product variant in membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contract-update-variant","href":"/memberships-admin-api/membership-contracts/update-product-variant-in-membership-contract"},{"title":"Create and add custom discount to membership","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-add-discount","href":"/memberships-admin-api/membership-contracts/create-and-add-custom-discount-to-membership"},{"title":"Add product to membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-add-line-item","href":"/memberships-admin-api/membership-contracts/add-product-to-membership-contract"},{"title":"Apply discount code to membership","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-apply-discount","href":"/memberships-admin-api/membership-contracts/apply-discount-code-to-membership"},{"title":"Send customer portal magic link via email","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-contracts-email-magic-link","href":"/memberships-admin-api/membership-contracts/send-customer-portal-magic-link-via-email"},{"title":"Remove discount from membership","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-remove-discount","href":"/memberships-admin-api/membership-contracts/remove-discount-from-membership"},{"title":"Remove product from membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-remove-line-item","href":"/memberships-admin-api/membership-contracts/remove-product-from-membership-contract"},{"title":"Update membership contract billing date","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-billing-date","href":"/memberships-admin-api/membership-contracts/update-membership-contract-billing-date"},{"title":"Update billing interval for membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-billing-interval","href":"/memberships-admin-api/membership-contracts/update-billing-interval-for-membership-contract"},{"title":"Update custom note attributes on membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-custom-note-attributes","href":"/memberships-admin-api/membership-contracts/update-custom-note-attributes-on-membership-contract"},{"title":"Update delivery interval for membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-delivery-interval","href":"/memberships-admin-api/membership-contracts/update-delivery-interval-for-membership-contract"},{"title":"Update membership line item quantity and pricing","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item","href":"/memberships-admin-api/membership-contracts/update-membership-line-item-quantity-and-pricing"},{"title":"Update custom attributes on membership line item","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-attributes","href":"/memberships-admin-api/membership-contracts/update-custom-attributes-on-membership-line-item"},{"title":"Update maximum billing cycles for membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-max-cycles","href":"/memberships-admin-api/membership-contracts/update-maximum-billing-cycles-for-membership-contract"},{"title":"Update minimum billing cycles for membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-min-cycles","href":"/memberships-admin-api/membership-contracts/update-minimum-billing-cycles-for-membership-contract"},{"title":"Update order note/instructions for membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-order-note/{contractId}","href":"/memberships-admin-api/membership-contracts/update-order-noteinstructions-for-membership-contract"},{"title":"Update membership payment method","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-payment-method","href":"/memberships-admin-api/membership-contracts/update-membership-payment-method"},{"title":"Update shipping address for membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-shipping-address","href":"/memberships-admin-api/membership-contracts/update-shipping-address-for-membership-contract"},{"title":"Update membership contract status (pause/resume/activate)","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-status","href":"/memberships-admin-api/membership-contracts/update-membership-contract-status-pauseresumeactivate"},{"title":"Get raw membership contract details from Shopify","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-contracts/contract-external/{contractId}","href":"/memberships-admin-api/membership-contracts/get-raw-membership-contract-details-from-shopify"},{"title":"Cancel membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json delete /api/external/v2/subscription-contracts/{id}","href":"/memberships-admin-api/membership-contracts/cancel-membership-contract"},{"title":"Get detailed customer membership information","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-customers-detail/valid/{customerId}","href":"/memberships-admin-api/membership-contracts/get-detailed-customer-membership-information"},{"title":"Sync customer information","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json delete /api/external/v2/subscription-customers/sync-info/{customerId}","href":"/memberships-admin-api/membership-contracts/sync-customer-information"},{"title":"Get valid membership contract IDs for customer","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-customers/valid/{customerId}","href":"/memberships-admin-api/membership-contracts/get-valid-membership-contract-ids-for-customer"},{"title":"Get membership customer details","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-customers/{customerId}","href":"/memberships-admin-api/membership-contracts/get-membership-customer-details"}]},{"group":"Shipping \u0026 Delivery Profiles","pages":[{"title":"Create shipping/delivery profile (V1 format - Legacy)","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json post /api/external/v2/delivery-profiles/create-shipping-profile","href":"/memberships-admin-api/shipping-\u0026-delivery-profiles/create-shippingdelivery-profile-v1-format--legacy"},{"title":"Create shipping/delivery profile (V2 format)","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json post /api/external/v2/delivery-profiles/v2/create-shipping-profile","href":"/memberships-admin-api/shipping-\u0026-delivery-profiles/create-shippingdelivery-profile-v2-format"}]},{"group":"Product Swap Rules","pages":[{"title":"Get product swap options for membership items","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json post /api/external/v2/product-swaps-by-variant-groups","href":"/memberships-admin-api/product-swap-rules/get-product-swap-options-for-membership-items"}]},{"group":"Billing \u0026 Orders","pages":[{"title":"Update membership billing attempt","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts","href":"/memberships-admin-api/billing-\u0026-orders/update-membership-billing-attempt"},{"title":"Update order note for billing attempt","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts-update-order-note/{id}","href":"/memberships-admin-api/billing-\u0026-orders/update-order-note-for-billing-attempt"},{"title":"Retry billing for failed attempt","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/attempt-billing/{id}","href":"/memberships-admin-api/billing-\u0026-orders/retry-billing-for-failed-attempt"},{"title":"Get past orders","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-billing-attempts/past-orders","href":"/memberships-admin-api/billing-\u0026-orders/get-past-orders"},{"title":"Get paginated past or upcoming orders report","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-billing-attempts/past-orders/report","href":"/memberships-admin-api/billing-\u0026-orders/get-paginated-past-or-upcoming-orders-report"},{"title":"Skip upcoming membership order","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/skip-order/{id}","href":"/memberships-admin-api/billing-\u0026-orders/skip-upcoming-membership-order"},{"title":"Get upcoming orders","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-billing-attempts/top-orders","href":"/memberships-admin-api/billing-\u0026-orders/get-upcoming-orders"}]},{"group":"One-Time Add-Ons","pages":[{"title":"Get one-time add-ons for a membership contract","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-contract-one-offs-by-contractId","href":"/memberships-admin-api/one-time-add-ons/get-one-time-add-ons-for-a-membership-contract"},{"title":"Add one-time product to upcoming order","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json put /api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/memberships-admin-api/one-time-add-ons/add-one-time-product-to-upcoming-order"},{"title":"Remove one-time product from upcoming order","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json delete /api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/memberships-admin-api/one-time-add-ons/remove-one-time-product-from-upcoming-order"}]},{"group":"Custom CSS Styling","pages":[{"title":"Get custom CSS styling configuration","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-custom-csses/{id}","href":"/memberships-admin-api/custom-css-styling/get-custom-css-styling-configuration"}]},{"group":"Membership Plans","pages":[{"title":"List all membership plan groups","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-groups","href":"/memberships-admin-api/membership-plans/list-all-membership-plan-groups"},{"title":"Get a membership plan group","deprecated":null,"version":null,"openapi":"/memberships/admin-api-swagger.json get /api/external/v2/subscription-groups/{subscriptionGroupId}","href":"/memberships-admin-api/membership-plans/get-a-membership-plan-group"}]}]},{"group":"Customer Portal API","pages":[{"group":"Cancellation Flow Configuration","pages":[{"title":"Get cancellation flow settings","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/cancellation-managements/{id}","href":"/memberships-customer-portal-api/cancellation-flow-configuration/get-cancellation-flow-settings"}]},{"group":"Customer Discount History","pages":[{"title":"Get past discount history","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/customer-discount-code-infos/get-past-discounts","href":"/memberships-customer-portal-api/customer-discount-history/get-past-discount-history"}]},{"group":"Customer Portal Configuration","pages":[{"title":"Get customer portal settings","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/customer-portal-settings/{id}","href":"/memberships-customer-portal-api/customer-portal-configuration/get-customer-portal-settings"},{"title":"Get customer portal label translations for locale","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/label-translations/locale","href":"/memberships-customer-portal-api/customer-portal-configuration/get-customer-portal-label-translations-for-locale"}]},{"group":"Customer Retention","pages":[{"title":"Create retention activity record","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json post /memberships/cp/api/customer-retention-activities","href":"/memberships-customer-portal-api/customer-retention/create-retention-activity-record"}]},{"group":"Product \u0026 Inventory Data","pages":[{"title":"Get product details by ID","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/data/product","href":"/memberships-customer-portal-api/product-\u0026-inventory-data/get-product-details-by-id"},{"title":"Get product with selling plans and variants","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/data/product-selling-plan-variant","href":"/memberships-customer-portal-api/product-\u0026-inventory-data/get-product-with-selling-plans-and-variants"},{"title":"Search membership-enabled products with pagination","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/data/products","href":"/memberships-customer-portal-api/product-\u0026-inventory-data/search-membership-enabled-products-with-pagination"},{"title":"List products attached to selling plans","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/data/selling-plan-products","href":"/memberships-customer-portal-api/product-\u0026-inventory-data/list-products-attached-to-selling-plans"},{"title":"Get contextual pricing for a variant by currency","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/data/variant-contextual-pricing","href":"/memberships-customer-portal-api/product-\u0026-inventory-data/get-contextual-pricing-for-a-variant-by-currency"}]},{"group":"Shipping \u0026 Delivery Profiles","pages":[{"title":"Get pickup locations","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/delivery-profiles/get-locations","href":"/memberships-customer-portal-api/shipping-\u0026-delivery-profiles/get-pickup-locations"}]},{"group":"Loyalty Integration","pages":[{"title":"Get loyalty customer details","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/loyalty-integration/customer","href":"/memberships-customer-portal-api/loyalty-integration/get-loyalty-customer-details"},{"title":"Get loyalty point earn options","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/loyalty-integration/earn-options","href":"/memberships-customer-portal-api/loyalty-integration/get-loyalty-point-earn-options"},{"title":"Redeem loyalty points","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json post /memberships/cp/api/loyalty-integration/redeem","href":"/memberships-customer-portal-api/loyalty-integration/redeem-loyalty-points"},{"title":"Get loyalty point redeem options","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/loyalty-integration/redeem-options","href":"/memberships-customer-portal-api/loyalty-integration/get-loyalty-point-redeem-options"}]},{"group":"notification-resource","pages":[{"title":"Get membershipscpapinotification session","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/notification-session","href":"/memberships-customer-portal-api/notification-resource/get-membershipscpapinotification-session"}]},{"group":"Product Swap Rules","pages":[{"title":"Get product swap options by variant","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json post /memberships/cp/api/product-swaps-by-variant-groups","href":"/memberships-customer-portal-api/product-swap-rules/get-product-swap-options-by-variant"}]},{"group":"Shop Settings","pages":[{"title":"Get shop info for current user","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/shop-infos-by-current-login","href":"/memberships-customer-portal-api/shop-settings/get-shop-info-for-current-user"}]},{"group":"Billing \u0026 Orders","pages":[{"title":"Update billing attempt","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-billing-attempts","href":"/memberships-customer-portal-api/billing-\u0026-orders/update-billing-attempt"},{"title":"Trigger billing attempt","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-billing-attempts/attempt-billing/{id}","href":"/memberships-customer-portal-api/billing-\u0026-orders/trigger-billing-attempt"},{"title":"Get past orders","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-billing-attempts/past-orders","href":"/memberships-customer-portal-api/billing-\u0026-orders/get-past-orders"},{"title":"Skip an upcoming billing order","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-billing-attempts/skip-order/{id}","href":"/memberships-customer-portal-api/billing-\u0026-orders/skip-an-upcoming-billing-order"},{"title":"Get upcoming orders","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-billing-attempts/top-orders","href":"/memberships-customer-portal-api/billing-\u0026-orders/get-upcoming-orders"}]},{"group":"Membership Contracts","pages":[{"title":"Update membership contract details","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contract-details","href":"/memberships-customer-portal-api/membership-contracts/update-membership-contract-details"},{"title":"Get current billing cycle","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-contract-details/current-cycle/{contractId}","href":"/memberships-customer-portal-api/membership-contracts/get-current-billing-cycle"},{"title":"Get customer membership details","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-contract-details/customer/{contractId}","href":"/memberships-customer-portal-api/membership-contracts/get-customer-membership-details"},{"title":"Get customer payment methods","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-contract-details/shopify/customer/{customerId}/payment-methods","href":"/memberships-customer-portal-api/membership-contracts/get-customer-payment-methods"},{"title":"List Shopify fulfillments for a membership contract","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-contract-details/subscription-fulfillments/{contractId}","href":"/memberships-customer-portal-api/membership-contracts/list-shopify-fulfillments-for-a-membership-contract"},{"title":"Get pending downgrade","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-contract-details/{contractId}/pending-downgrade","href":"/memberships-customer-portal-api/membership-contracts/get-pending-downgrade"},{"title":"Cancel pending downgrade","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json delete /memberships/cp/api/subscription-contract-details/{contractId}/pending-downgrade","href":"/memberships-customer-portal-api/membership-contracts/cancel-pending-downgrade"},{"title":"Update line item variant","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contract-update-variant","href":"/memberships-customer-portal-api/membership-contracts/update-line-item-variant"},{"title":"Apply discount code","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-apply-discount","href":"/memberships-customer-portal-api/membership-contracts/apply-discount-code"},{"title":"Apply cancellation retention discount","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-cancellation-discount","href":"/memberships-customer-portal-api/membership-contracts/apply-cancellation-retention-discount"},{"title":"Send magic link email","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-contracts-email-magic-link","href":"/memberships-customer-portal-api/membership-contracts/send-magic-link-email"},{"title":"Remove discount from contract","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-remove-discount","href":"/memberships-customer-portal-api/membership-contracts/remove-discount-from-contract"},{"title":"Remove line item from contract","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-remove-line-item","href":"/memberships-customer-portal-api/membership-contracts/remove-line-item-from-contract"},{"title":"Update next billing date","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-update-billing-date","href":"/memberships-customer-portal-api/membership-contracts/update-next-billing-date"},{"title":"Update billing interval","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-update-billing-interval","href":"/memberships-customer-portal-api/membership-contracts/update-billing-interval"},{"title":"Update existing payment method details","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-update-existing-payment-method","href":"/memberships-customer-portal-api/membership-contracts/update-existing-payment-method-details"},{"title":"Update line item attributes","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-update-line-item-attributes","href":"/memberships-customer-portal-api/membership-contracts/update-line-item-attributes"},{"title":"Update order note","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-update-order-note/{contractId}","href":"/memberships-customer-portal-api/membership-contracts/update-order-note"},{"title":"Update payment method","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-update-payment-method","href":"/memberships-customer-portal-api/membership-contracts/update-payment-method"},{"title":"Update shipping address","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-update-shipping-address","href":"/memberships-customer-portal-api/membership-contracts/update-shipping-address"},{"title":"Update membership contract status","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contracts-update-status","href":"/memberships-customer-portal-api/membership-contracts/update-membership-contract-status"},{"title":"Get raw Shopify membership contract data","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-contracts/contract-external/{contractId}","href":"/memberships-customer-portal-api/membership-contracts/get-raw-shopify-membership-contract-data"},{"title":"Get membership contract details","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-contracts/contract/{contractId}","href":"/memberships-customer-portal-api/membership-contracts/get-membership-contract-details"},{"title":"Cancel a membership contract","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json delete /memberships/cp/api/subscription-contracts/{id}","href":"/memberships-customer-portal-api/membership-contracts/cancel-a-membership-contract"},{"title":"Get current customer's membership profile","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-customers","href":"/memberships-customer-portal-api/membership-contracts/get-current-customers-membership-profile"},{"title":"Get valid membership contracts for a customer","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-customers-detail/valid/{id}","href":"/memberships-customer-portal-api/membership-contracts/get-valid-membership-contracts-for-a-customer"},{"title":"List current customer's valid membership contract IDs","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-customers/valid","href":"/memberships-customer-portal-api/membership-contracts/list-current-customers-valid-membership-contract-ids"},{"title":"Add line item to contract","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/v2/subscription-contracts-add-line-item","href":"/memberships-customer-portal-api/membership-contracts/add-line-item-to-contract"}]},{"group":"One-Time Add-Ons","pages":[{"title":"Get one-off items for contract","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-contract-one-offs-by-contractId","href":"/memberships-customer-portal-api/one-time-add-ons/get-one-off-items-for-contract"},{"title":"Add or update one-off item","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json put /memberships/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/memberships-customer-portal-api/one-time-add-ons/add-or-update-one-off-item"}]},{"group":"Custom CSS Styling","pages":[{"title":"Get custom CSS styles","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-custom-csses/{id}","href":"/memberships-customer-portal-api/custom-css-styling/get-custom-css-styles"}]},{"group":"Membership Plans","pages":[{"title":"Get all selling plans","deprecated":null,"version":null,"openapi":"/memberships/storefront-api-swagger.json get /memberships/cp/api/subscription-groups/all-selling-plans","href":"/memberships-customer-portal-api/membership-plans/get-all-selling-plans"}]}]}]},{"product":"Bundles","icon":"boxes-stacked","description":"Fixed, dynamic, and volume-discount bundles plus Build-a-Box","pages":[{"title":"Bundles","href":"/bundles/introduction"}]}]},"title":"Add product line item to membership contract - Appstle","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-D5fEM6aW.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}