Replace product variants in a subscription contract
Replaces existing product variants with new ones in a subscription contract, so you can swap products and change quantities. On the Admin API, the same call can also add and remove one-time products.
Key Features:
Bulk Replace: Replace multiple products at once by providing lists of old and new variants
Line-Specific Replace: Target a specific line item using oldLineId for precise replacement
Quantity Management: Set new quantities for replaced products
One-Time Products (Admin API only): Add or remove one-time purchase products with newOneTimeVariants and oldOneTimeVariants
Discounts: The store’s customer portal setting decides the new products’ discount (see below)
Discounts on the new products:
The store’s Discount policy for added products setting decides which discount the new products get, on both the Admin API and the Storefront API. The request body’s carryForwardDiscount field is ignored. Merchants choose the policy in the Appstle Subscriptions app under Customer Portal: in Portal Editor → Settings → More rules → Discounts on added products, or, on stores without the Portal Editor, in Configuration → Order & Subscription Management. The default is the first option:
Use product’s plan first, then current subscription discount (PRODUCT_THEN_EXISTING): a product in a plan with the same order frequency as this subscription gets that plan’s discount. Other products, and products whose matching plan has no discount, get the subscription’s current discount
Apply product’s own subscription discount (PRODUCT_PLAN): a product in a plan with the same order frequency as this subscription gets that plan’s discount. Other products get no discount
Apply current subscription discount (EXISTING_PLAN): the new products get the same discount as the subscription’s existing items, including manual price adjustments
No discount on added products (NONE): the new products are charged at their regular price
On a prepaid subscription that ships as separate orders, the new products always get EXISTING_PLAN pricing, whatever the setting.
Important Notes:
One-time and free product lines can’t be replaced. These lines carry the _appstle-one-time-product attribute, or _appstle-free-product set to true. Passing such a line’s variant in oldVariants, or its ID as oldLineId, returns a 400. On the Admin API, remove a one-time line with oldOneTimeVariants instead
The replacement line gets a new id, so take line IDs from the latest response. An oldLineId that isn’t on the contract returns a 400
The merchant’s minimum order value applies to both APIs. If the products’ total after the change would be below minOrderValue in the customer portal settings, the call returns a 400 with the error key minOrderValueNotMet
On the Admin API, a request whose oldVariants, newVariants, oldLineId, newOneTimeVariants and oldOneTimeVariants are all empty or missing changes nothing and returns a 200 with an empty body
On a prepaid subscription, the new line’s price covers all the deliveries in one billing period
The shipping price is recalculated in the background after the change, unless the merchant turned off automatic shipping price calculation or set a custom delivery price on the subscription
Storefront API calls:
When a signed-in customer makes this call through the Storefront API, the merchant’s customer portal settings apply. Merchants set them in the Appstle Subscriptions app under Customer Portal. Read them from Get customer portal settings and offer only the changes they allow. The call returns a 400 when:
Swapping is turned off:enableSwapProductFeature and enableSwapProductVariant are both false. The response has no errorKey, and its entityName is swapProductVariant. Offer swapping only when one of them is true
A quantity is below the minimum: a quantity in newVariants is lower than minQtyToAllowDuringAddProduct. The response has no errorKey
The subscription is locked until its minimum cycles:freezeOrderTillMinCycle is true, allowSwapWhenContractIsFreeze isn’t true, and the subscription hasn’t reached its minimum number of billing cycles. The message is the merchant’s freezeUpdateSubscriptionMessage, and the error key is minCycleNotCompleteForUpdateSubscriptionContractDate
The subscription is prepaid with separate orders:allowEditQuantityPrepaidSeparatePlan is false. The error key is permissionDenied
A new variant isn’t allowed: the variant is in disAllowVariantIdsForSubscriptionProductAdd; or allowProductIdsForSubscriptionProductAdd isn’t empty and holds neither the variant nor its product; or productSelectionOption is PRODUCTS_FROM_ALL_PLANS or PRODUCTS_FROM_CURRENT_PLAN and neither the variant nor its product is in a subscription plan. The error key is productnotallowedforcustomerportal
Admin API calls with an API key skip all of these checks. Storefront API calls ignore newOneTimeVariants, oldOneTimeVariants and stopSwapEmails: use the Subscription One-Time Products endpoints for one-time products.
Use Cases:
Product upgrades/downgrades (e.g., switching coffee blend or size)
Quantity adjustments during product swap
Adding limited-time or seasonal products as one-time purchases (Admin API only)
Bulk product replacements for subscription migrations
Authentication: Requires a signed-in customer. Call it through Shopify’s App Proxy on the store’s domain: the proxy signs the request and attaches the customer, so you send no API key.
POST
/
subscriptions
/
cp
/
api
/
subscription-contract-details
/
replace-variants-v3
Replace product variants in a subscription contract
Product replacement configuration for subscription contracts. Allows replacing existing subscription products with new ones, managing quantities, and handling one-time purchases.
contractId
integer<int64>
required
The ID of the subscription contract to modify
Example:
123456789
carryForwardDiscount
enum<string>
deprecated
Ignored. The store's "Discount policy for added products" customer portal setting decides the discount on the new products.
Available options:
NONE,
EXISTING_PLAN,
PRODUCT_PLAN,
PRODUCT_THEN_EXISTING
newOneTimeVariants
object
Map of one-time product variant IDs to add with their quantities. These products will be charged only once with the next order and won't recur. Useful for add-ons, samples, or limited-time offers.
Show child attributes
Example:
{ "42549172066666": 1, "42549172077777": 2 }
newVariants
object
Map of new variant IDs to their quantities. Key is the numeric Shopify variant ID, value is the desired quantity. If a variant already exists in the subscription and the system is configured to update existing quantities, the quantity will be added to the existing quantity.
Show child attributes
Example:
{ "42549172033333": 2, "42549172044444": 1 }
oldLineId
string
Specific subscription line ID to replace. Use this for targeted replacement of a single line item. When provided, oldVariants should be empty. Format: gid://shopify/SubscriptionLine/[ID]
Example:
"gid://shopify/SubscriptionLine/987654321"
oldOneTimeVariants
integer<int64>[]
List of one-time product variant IDs to remove from the subscription. Only removes one-time products that haven't been fulfilled yet.
List of one-time product variant IDs to remove from the subscription. Only removes one-time products that haven't been fulfilled yet.
Example:
[42549172055555, 42549172088888]
oldVariants
integer<int64>[]
List of variant IDs to remove from the subscription. These are numeric Shopify variant IDs. Either provide oldVariants OR oldLineId, not both.
List of variant IDs to remove from the subscription. These are numeric Shopify variant IDs. Either provide oldVariants OR oldLineId, not both.
Example:
[42549172011164, 42549172022222]
stopSwapEmails
boolean
default:false
If true, suppresses email notifications about the product swap. Default is false (emails will be sent).
Example:
false
Response
Products successfully replaced
billingAttempts
object
Show child attributes
billingPolicy
object
Show child attributes
createdAt
object
customAttributes
object[]
Show child attributes
customer
object
Show child attributes
customerPaymentMethod
object
Show child attributes
deliveryMethod
object
Show child attributes
deliveryPolicy
object
Show child attributes
deliveryPrice
object
Show child attributes
discounts
object
Show child attributes
get__typename
string
id
string
lastPaymentStatus
enum<string>
Available options:
SUCCEEDED,
FAILED,
$UNKNOWN
lines
object
Show child attributes
nextBillingDate
object
note
string
originOrder
object
Show child attributes
revisionId
object
status
enum<string>
Available options:
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED,
FAILED,
$UNKNOWN
updatedAt
object
⌘I
Replace product variants in a subscription contract
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Appstle","colors":{"primary":"#0caceb","light":"#6ccdf2","dark":"#0a7eae"},"favicon":"https://mintcdn.com/appstleinc-aeca3e0a/811jRr2WFwD6kXFw/favicon.webp?fit=max\u0026auto=format\u0026n=811jRr2WFwD6kXFw\u0026q=85\u0026s=a98f329ae5c5ff4deaa241d8abe53f11","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","python","javascript","node","php","go","ruby"]}},"appearance":{"default":"light","strict":true},"navbar":{"primary":{"type":"button","label":"Help Center","href":"https://help.appstle.com/en/"}},"footer":{"socials":{"website":"https://appstle.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"appstleinc-aeca3e0a","hasAudioNarration":false,"actualSubdomain":"appstleinc-aeca3e0a","customDomains":["developers.appstle.com"],"gitSource":{"type":"github","owner":"appstleinc","repo":"appstle-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6b03186c9421b24d9c4434c6","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Subscriptions","count":267},{"language":"default","tag":"Storefront API","count":219},{"language":"default","tag":"Admin API","count":185},{"language":"default","tag":"Memberships","count":120},{"language":"default","tag":"Membership Contracts","count":62},{"language":"default","tag":"Subscription Contracts","count":62},{"language":"default","tag":"Loyalty","count":49},{"language":"default","tag":"Bundles","count":25},{"language":"default","tag":"Billing \u0026 Payments","count":25},{"language":"default","tag":"Subscription Management","count":25}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract","slug":"/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract","pageMetadata":{"title":"Replace product variants in a subscription contract","description":"Replaces existing product variants with new ones in a subscription contract, so you can swap products and change quantities. On the Admin API, the same call can also add and remove one-time products.\n\n**Key Features:**\n- **Bulk Replace**: Replace multiple products at once by providing lists of old and new variants\n- **Line-Specific Replace**: Target a specific line item using `oldLineId` for precise replacement\n- **Quantity Management**: Set new quantities for replaced products\n- **One-Time Products** (Admin API only): Add or remove one-time purchase products with `newOneTimeVariants` and `oldOneTimeVariants`\n- **Discounts**: The store's customer portal setting decides the new products' discount (see below)\n\n**Discounts on the new products:**\nThe store's **Discount policy for added products** setting decides which discount the new products get, on both the Admin API and the Storefront API. The request body's `carryForwardDiscount` field is ignored. Merchants choose the policy in the Appstle Subscriptions app under **Customer Portal**: in **Portal Editor** → **Settings** → **More rules** → **Discounts on added products**, or, on stores without the Portal Editor, in **Configuration** → **Order \u0026 Subscription Management**. The default is the first option:\n- **Use product's plan first, then current subscription discount** (`PRODUCT_THEN_EXISTING`): a product in a plan with the same order frequency as this subscription gets that plan's discount. Other products, and products whose matching plan has no discount, get the subscription's current discount\n- **Apply product's own subscription discount** (`PRODUCT_PLAN`): a product in a plan with the same order frequency as this subscription gets that plan's discount. Other products get no discount\n- **Apply current subscription discount** (`EXISTING_PLAN`): the new products get the same discount as the subscription's existing items, including manual price adjustments\n- **No discount on added products** (`NONE`): the new products are charged at their regular price\nOn a prepaid subscription that ships as separate orders, the new products always get `EXISTING_PLAN` pricing, whatever the setting.\n\n**Important Notes:**\n- One-time and free product lines can't be replaced. These lines carry the `_appstle-one-time-product` attribute, or `_appstle-free-product` set to `true`. Passing such a line's variant in `oldVariants`, or its ID as `oldLineId`, returns a 400. On the Admin API, remove a one-time line with `oldOneTimeVariants` instead\n- The replacement line gets a new `id`, so take line IDs from the latest response. An `oldLineId` that isn't on the contract returns a 400\n- The merchant's minimum order value applies to both APIs. If the products' total after the change would be below `minOrderValue` in the customer portal settings, the call returns a 400 with the error key `minOrderValueNotMet`\n- On the Admin API, a request whose `oldVariants`, `newVariants`, `oldLineId`, `newOneTimeVariants` and `oldOneTimeVariants` are all empty or missing changes nothing and returns a 200 with an empty body\n- On a prepaid subscription, the new line's price covers all the deliveries in one billing period\n- The shipping price is recalculated in the background after the change, unless the merchant turned off automatic shipping price calculation or set a custom delivery price on the subscription\n\n**Storefront API calls:**\nWhen a signed-in customer makes this call through the Storefront API, the merchant's customer portal settings apply. Merchants set them in the Appstle Subscriptions app under **Customer Portal**. Read them from [Get customer portal settings](https://developers.appstle.com/subscription-storefront-api/customization/get-customer-portal-settings) and offer only the changes they allow. The call returns a 400 when:\n- **Swapping is turned off:** `enableSwapProductFeature` and `enableSwapProductVariant` are both `false`. The response has no `errorKey`, and its `entityName` is `swapProductVariant`. Offer swapping only when one of them is `true`\n- **A quantity is below the minimum:** a quantity in `newVariants` is lower than `minQtyToAllowDuringAddProduct`. The response has no `errorKey`\n- **The subscription is locked until its minimum cycles:** `freezeOrderTillMinCycle` is `true`, `allowSwapWhenContractIsFreeze` isn't `true`, and the subscription hasn't reached its minimum number of billing cycles. The message is the merchant's `freezeUpdateSubscriptionMessage`, and the error key is `minCycleNotCompleteForUpdateSubscriptionContractDate`\n- **The subscription is prepaid with separate orders:** `allowEditQuantityPrepaidSeparatePlan` is `false`. The error key is `permissionDenied`\n- **A new variant isn't allowed:** the variant is in `disAllowVariantIdsForSubscriptionProductAdd`; or `allowProductIdsForSubscriptionProductAdd` isn't empty and holds neither the variant nor its product; or `productSelectionOption` is `PRODUCTS_FROM_ALL_PLANS` or `PRODUCTS_FROM_CURRENT_PLAN` and neither the variant nor its product is in a subscription plan. The error key is `productnotallowedforcustomerportal`\n\nAdmin API calls with an API key skip all of these checks. Storefront API calls ignore `newOneTimeVariants`, `oldOneTimeVariants` and `stopSwapEmails`: use the Subscription One-Time Products endpoints for one-time products.\n\n**Use Cases:**\n- Product upgrades/downgrades (e.g., switching coffee blend or size)\n- Quantity adjustments during product swap\n- Adding limited-time or seasonal products as one-time purchases (Admin API only)\n- Bulk product replacements for subscription migrations\n\n**Authentication:** Requires a signed-in customer. Call it through Shopify's App Proxy on the store's domain: the proxy signs the request and attaches the customer, so you send no API key.","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/replace-variants-v3","href":"/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract","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 a: \"a\",\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Replaces existing product variants with new ones in a subscription contract, so you can swap products and change quantities. On the Admin API, the same call can also add and remove one-time products.\"\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: \"Bulk Replace\"\n }), \": Replace multiple products at once by providing lists of old and new variants\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Line-Specific Replace\"\n }), \": Target a specific line item using \", _jsx(_components.code, {\n children: \"oldLineId\"\n }), \" for precise replacement\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Quantity Management\"\n }), \": Set new quantities for replaced products\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"One-Time Products\"\n }), \" (Admin API only): Add or remove one-time purchase products with \", _jsx(_components.code, {\n children: \"newOneTimeVariants\"\n }), \" and \", _jsx(_components.code, {\n children: \"oldOneTimeVariants\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Discounts\"\n }), \": The store’s customer portal setting decides the new products’ discount (see below)\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Discounts on the new products:\"\n }), \"\\nThe store’s \", _jsx(_components.strong, {\n children: \"Discount policy for added products\"\n }), \" setting decides which discount the new products get, on both the Admin API and the Storefront API. The request body’s \", _jsx(_components.code, {\n children: \"carryForwardDiscount\"\n }), \" field is ignored. Merchants choose the policy in the Appstle Subscriptions app under \", _jsx(_components.strong, {\n children: \"Customer Portal\"\n }), \": in \", _jsx(_components.strong, {\n children: \"Portal Editor\"\n }), \" → \", _jsx(_components.strong, {\n children: \"Settings\"\n }), \" → \", _jsx(_components.strong, {\n children: \"More rules\"\n }), \" → \", _jsx(_components.strong, {\n children: \"Discounts on added products\"\n }), \", or, on stores without the Portal Editor, in \", _jsx(_components.strong, {\n children: \"Configuration\"\n }), \" → \", _jsx(_components.strong, {\n children: \"Order \u0026 Subscription Management\"\n }), \". The default is the first option:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Use product’s plan first, then current subscription discount\"\n }), \" (\", _jsx(_components.code, {\n children: \"PRODUCT_THEN_EXISTING\"\n }), \"): a product in a plan with the same order frequency as this subscription gets that plan’s discount. Other products, and products whose matching plan has no discount, get the subscription’s current discount\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Apply product’s own subscription discount\"\n }), \" (\", _jsx(_components.code, {\n children: \"PRODUCT_PLAN\"\n }), \"): a product in a plan with the same order frequency as this subscription gets that plan’s discount. Other products get no discount\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Apply current subscription discount\"\n }), \" (\", _jsx(_components.code, {\n children: \"EXISTING_PLAN\"\n }), \"): the new products get the same discount as the subscription’s existing items, including manual price adjustments\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"No discount on added products\"\n }), \" (\", _jsx(_components.code, {\n children: \"NONE\"\n }), \"): the new products are charged at their regular price\\nOn a prepaid subscription that ships as separate orders, the new products always get \", _jsx(_components.code, {\n children: \"EXISTING_PLAN\"\n }), \" pricing, whatever the setting.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Important Notes:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"One-time and free product lines can’t be replaced. These lines carry the \", _jsx(_components.code, {\n children: \"_appstle-one-time-product\"\n }), \" attribute, or \", _jsx(_components.code, {\n children: \"_appstle-free-product\"\n }), \" set to \", _jsx(_components.code, {\n children: \"true\"\n }), \". Passing such a line’s variant in \", _jsx(_components.code, {\n children: \"oldVariants\"\n }), \", or its ID as \", _jsx(_components.code, {\n children: \"oldLineId\"\n }), \", returns a 400. On the Admin API, remove a one-time line with \", _jsx(_components.code, {\n children: \"oldOneTimeVariants\"\n }), \" instead\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"The replacement line gets a new \", _jsx(_components.code, {\n children: \"id\"\n }), \", so take line IDs from the latest response. An \", _jsx(_components.code, {\n children: \"oldLineId\"\n }), \" that isn’t on the contract returns a 400\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"The merchant’s minimum order value applies to both APIs. If the products’ total after the change would be below \", _jsx(_components.code, {\n children: \"minOrderValue\"\n }), \" in the customer portal settings, the call returns a 400 with the error key \", _jsx(_components.code, {\n children: \"minOrderValueNotMet\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"On the Admin API, a request whose \", _jsx(_components.code, {\n children: \"oldVariants\"\n }), \", \", _jsx(_components.code, {\n children: \"newVariants\"\n }), \", \", _jsx(_components.code, {\n children: \"oldLineId\"\n }), \", \", _jsx(_components.code, {\n children: \"newOneTimeVariants\"\n }), \" and \", _jsx(_components.code, {\n children: \"oldOneTimeVariants\"\n }), \" are all empty or missing changes nothing and returns a 200 with an empty body\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"On a prepaid subscription, the new line’s price covers all the deliveries in one billing period\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"The shipping price is recalculated in the background after the change, unless the merchant turned off automatic shipping price calculation or set a custom delivery price on the subscription\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Storefront API calls:\"\n }), \"\\nWhen a signed-in customer makes this call through the Storefront API, the merchant’s customer portal settings apply. Merchants set them in the Appstle Subscriptions app under \", _jsx(_components.strong, {\n children: \"Customer Portal\"\n }), \". Read them from \", _jsx(_components.a, {\n href: \"https://developers.appstle.com/subscription-storefront-api/customization/get-customer-portal-settings\",\n children: \"Get customer portal settings\"\n }), \" and offer only the changes they allow. The call returns a 400 when:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Swapping is turned off:\"\n }), \" \", _jsx(_components.code, {\n children: \"enableSwapProductFeature\"\n }), \" and \", _jsx(_components.code, {\n children: \"enableSwapProductVariant\"\n }), \" are both \", _jsx(_components.code, {\n children: \"false\"\n }), \". The response has no \", _jsx(_components.code, {\n children: \"errorKey\"\n }), \", and its \", _jsx(_components.code, {\n children: \"entityName\"\n }), \" is \", _jsx(_components.code, {\n children: \"swapProductVariant\"\n }), \". Offer swapping only when one of them is \", _jsx(_components.code, {\n children: \"true\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"A quantity is below the minimum:\"\n }), \" a quantity in \", _jsx(_components.code, {\n children: \"newVariants\"\n }), \" is lower than \", _jsx(_components.code, {\n children: \"minQtyToAllowDuringAddProduct\"\n }), \". The response has no \", _jsx(_components.code, {\n children: \"errorKey\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"The subscription is locked until its minimum cycles:\"\n }), \" \", _jsx(_components.code, {\n children: \"freezeOrderTillMinCycle\"\n }), \" is \", _jsx(_components.code, {\n children: \"true\"\n }), \", \", _jsx(_components.code, {\n children: \"allowSwapWhenContractIsFreeze\"\n }), \" isn’t \", _jsx(_components.code, {\n children: \"true\"\n }), \", and the subscription hasn’t reached its minimum number of billing cycles. The message is the merchant’s \", _jsx(_components.code, {\n children: \"freezeUpdateSubscriptionMessage\"\n }), \", and the error key is \", _jsx(_components.code, {\n children: \"minCycleNotCompleteForUpdateSubscriptionContractDate\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"The subscription is prepaid with separate orders:\"\n }), \" \", _jsx(_components.code, {\n children: \"allowEditQuantityPrepaidSeparatePlan\"\n }), \" is \", _jsx(_components.code, {\n children: \"false\"\n }), \". The error key is \", _jsx(_components.code, {\n children: \"permissionDenied\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"A new variant isn’t allowed:\"\n }), \" the variant is in \", _jsx(_components.code, {\n children: \"disAllowVariantIdsForSubscriptionProductAdd\"\n }), \"; or \", _jsx(_components.code, {\n children: \"allowProductIdsForSubscriptionProductAdd\"\n }), \" isn’t empty and holds neither the variant nor its product; or \", _jsx(_components.code, {\n children: \"productSelectionOption\"\n }), \" is \", _jsx(_components.code, {\n children: \"PRODUCTS_FROM_ALL_PLANS\"\n }), \" or \", _jsx(_components.code, {\n children: \"PRODUCTS_FROM_CURRENT_PLAN\"\n }), \" and neither the variant nor its product is in a subscription plan. The error key is \", _jsx(_components.code, {\n children: \"productnotallowedforcustomerportal\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Admin API calls with an API key skip all of these checks. Storefront API calls ignore \", _jsx(_components.code, {\n children: \"newOneTimeVariants\"\n }), \", \", _jsx(_components.code, {\n children: \"oldOneTimeVariants\"\n }), \" and \", _jsx(_components.code, {\n children: \"stopSwapEmails\"\n }), \": use the Subscription One-Time Products endpoints for one-time products.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Use Cases:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Product upgrades/downgrades (e.g., switching coffee blend or size)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Quantity adjustments during product swap\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Adding limited-time or seasonal products as one-time purchases (Admin API only)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Bulk product replacements for subscription migrations\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Authentication:\"\n }), \" Requires a signed-in customer. Call it through Shopify’s App Proxy on the store’s domain: the proxy signs the request and attaches the customer, so you send no API key.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Replace product variants in a subscription contract","description":"Replaces existing product variants with new ones in a subscription contract, so you can swap products and change quantities. On the Admin API, the same call can also add and remove one-time products.\n\n**Key Features:**\n- **Bulk Replace**: Replace multiple products at once by providing lists of old and new variants\n- **Line-Specific Replace**: Target a specific line item using `oldLineId` for precise replacement\n- **Quantity Management**: Set new quantities for replaced products\n- **One-Time Products** (Admin API only): Add or remove one-time purchase products with `newOneTimeVariants` and `oldOneTimeVariants`\n- **Discounts**: The store's customer portal setting decides the new products' discount (see below)\n\n**Discounts on the new products:**\nThe store's **Discount policy for added products** setting decides which discount the new products get, on both the Admin API and the Storefront API. The request body's `carryForwardDiscount` field is ignored. Merchants choose the policy in the Appstle Subscriptions app under **Customer Portal**: in **Portal Editor** → **Settings** → **More rules** → **Discounts on added products**, or, on stores without the Portal Editor, in **Configuration** → **Order \u0026 Subscription Management**. The default is the first option:\n- **Use product's plan first, then current subscription discount** (`PRODUCT_THEN_EXISTING`): a product in a plan with the same order frequency as this subscription gets that plan's discount. Other products, and products whose matching plan has no discount, get the subscription's current discount\n- **Apply product's own subscription discount** (`PRODUCT_PLAN`): a product in a plan with the same order frequency as this subscription gets that plan's discount. Other products get no discount\n- **Apply current subscription discount** (`EXISTING_PLAN`): the new products get the same discount as the subscription's existing items, including manual price adjustments\n- **No discount on added products** (`NONE`): the new products are charged at their regular price\nOn a prepaid subscription that ships as separate orders, the new products always get `EXISTING_PLAN` pricing, whatever the setting.\n\n**Important Notes:**\n- One-time and free product lines can't be replaced. These lines carry the `_appstle-one-time-product` attribute, or `_appstle-free-product` set to `true`. Passing such a line's variant in `oldVariants`, or its ID as `oldLineId`, returns a 400. On the Admin API, remove a one-time line with `oldOneTimeVariants` instead\n- The replacement line gets a new `id`, so take line IDs from the latest response. An `oldLineId` that isn't on the contract returns a 400\n- The merchant's minimum order value applies to both APIs. If the products' total after the change would be below `minOrderValue` in the customer portal settings, the call returns a 400 with the error key `minOrderValueNotMet`\n- On the Admin API, a request whose `oldVariants`, `newVariants`, `oldLineId`, `newOneTimeVariants` and `oldOneTimeVariants` are all empty or missing changes nothing and returns a 200 with an empty body\n- On a prepaid subscription, the new line's price covers all the deliveries in one billing period\n- The shipping price is recalculated in the background after the change, unless the merchant turned off automatic shipping price calculation or set a custom delivery price on the subscription\n\n**Storefront API calls:**\nWhen a signed-in customer makes this call through the Storefront API, the merchant's customer portal settings apply. Merchants set them in the Appstle Subscriptions app under **Customer Portal**. Read them from [Get customer portal settings](https://developers.appstle.com/subscription-storefront-api/customization/get-customer-portal-settings) and offer only the changes they allow. The call returns a 400 when:\n- **Swapping is turned off:** `enableSwapProductFeature` and `enableSwapProductVariant` are both `false`. The response has no `errorKey`, and its `entityName` is `swapProductVariant`. Offer swapping only when one of them is `true`\n- **A quantity is below the minimum:** a quantity in `newVariants` is lower than `minQtyToAllowDuringAddProduct`. The response has no `errorKey`\n- **The subscription is locked until its minimum cycles:** `freezeOrderTillMinCycle` is `true`, `allowSwapWhenContractIsFreeze` isn't `true`, and the subscription hasn't reached its minimum number of billing cycles. The message is the merchant's `freezeUpdateSubscriptionMessage`, and the error key is `minCycleNotCompleteForUpdateSubscriptionContractDate`\n- **The subscription is prepaid with separate orders:** `allowEditQuantityPrepaidSeparatePlan` is `false`. The error key is `permissionDenied`\n- **A new variant isn't allowed:** the variant is in `disAllowVariantIdsForSubscriptionProductAdd`; or `allowProductIdsForSubscriptionProductAdd` isn't empty and holds neither the variant nor its product; or `productSelectionOption` is `PRODUCTS_FROM_ALL_PLANS` or `PRODUCTS_FROM_CURRENT_PLAN` and neither the variant nor its product is in a subscription plan. The error key is `productnotallowedforcustomerportal`\n\nAdmin API calls with an API key skip all of these checks. Storefront API calls ignore `newOneTimeVariants`, `oldOneTimeVariants` and `stopSwapEmails`: use the Subscription One-Time Products endpoints for one-time products.\n\n**Use Cases:**\n- Product upgrades/downgrades (e.g., switching coffee blend or size)\n- Quantity adjustments during product swap\n- Adding limited-time or seasonal products as one-time purchases (Admin API only)\n- Bulk product replacements for subscription migrations\n\n**Authentication:** Requires a signed-in customer. Call it through Shopify's App Proxy on the store's domain: the proxy signs the request and attaches the customer, so you send no API key.","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/replace-variants-v3","href":"/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Replaces existing product variants with new ones in a subscription contract, so you can swap products and change quantities. On the Admin API, the same call can also add and remove one-time products.\n\n**Key Features:**\n- **Bulk Replace**: Replace multiple products at once by providing lists of old and new variants\n- **Line-Specific Replace**: Target a specific line item using `oldLineId` for precise replacement\n- **Quantity Management**: Set new quantities for replaced products\n- **One-Time Products** (Admin API only): Add or remove one-time purchase products with `newOneTimeVariants` and `oldOneTimeVariants`\n- **Discounts**: The store's customer portal setting decides the new products' discount (see below)\n\n**Discounts on the new products:**\nThe store's **Discount policy for added products** setting decides which discount the new products get, on both the Admin API and the Storefront API. The request body's `carryForwardDiscount` field is ignored. Merchants choose the policy in the Appstle Subscriptions app under **Customer Portal**: in **Portal Editor** → **Settings** → **More rules** → **Discounts on added products**, or, on stores without the Portal Editor, in **Configuration** → **Order \u0026 Subscription Management**. The default is the first option:\n- **Use product's plan first, then current subscription discount** (`PRODUCT_THEN_EXISTING`): a product in a plan with the same order frequency as this subscription gets that plan's discount. Other products, and products whose matching plan has no discount, get the subscription's current discount\n- **Apply product's own subscription discount** (`PRODUCT_PLAN`): a product in a plan with the same order frequency as this subscription gets that plan's discount. Other products get no discount\n- **Apply current subscription discount** (`EXISTING_PLAN`): the new products get the same discount as the subscription's existing items, including manual price adjustments\n- **No discount on added products** (`NONE`): the new products are charged at their regular price\nOn a prepaid subscription that ships as separate orders, the new products always get `EXISTING_PLAN` pricing, whatever the setting.\n\n**Important Notes:**\n- One-time and free product lines can't be replaced. These lines carry the `_appstle-one-time-product` attribute, or `_appstle-free-product` set to `true`. Passing such a line's variant in `oldVariants`, or its ID as `oldLineId`, returns a 400. On the Admin API, remove a one-time line with `oldOneTimeVariants` instead\n- The replacement line gets a new `id`, so take line IDs from the latest response. An `oldLineId` that isn't on the contract returns a 400\n- The merchant's minimum order value applies to both APIs. If the products' total after the change would be below `minOrderValue` in the customer portal settings, the call returns a 400 with the error key `minOrderValueNotMet`\n- On the Admin API, a request whose `oldVariants`, `newVariants`, `oldLineId`, `newOneTimeVariants` and `oldOneTimeVariants` are all empty or missing changes nothing and returns a 200 with an empty body\n- On a prepaid subscription, the new line's price covers all the deliveries in one billing period\n- The shipping price is recalculated in the background after the change, unless the merchant turned off automatic shipping price calculation or set a custom delivery price on the subscription\n\n**Storefront API calls:**\nWhen a signed-in customer makes this call through the Storefront API, the merchant's customer portal settings apply. Merchants set them in the Appstle Subscriptions app under **Customer Portal**. Read them from [Get customer portal settings](https://developers.appstle.com/subscription-storefront-api/customization/get-customer-portal-settings) and offer only the changes they allow. The call returns a 400 when:\n- **Swapping is turned off:** `enableSwapProductFeature` and `enableSwapProductVariant` are both `false`. The response has no `errorKey`, and its `entityName` is `swapProductVariant`. Offer swapping only when one of them is `true`\n- **A quantity is below the minimum:** a quantity in `newVariants` is lower than `minQtyToAllowDuringAddProduct`. The response has no `errorKey`\n- **The subscription is locked until its minimum cycles:** `freezeOrderTillMinCycle` is `true`, `allowSwapWhenContractIsFreeze` isn't `true`, and the subscription hasn't reached its minimum number of billing cycles. The message is the merchant's `freezeUpdateSubscriptionMessage`, and the error key is `minCycleNotCompleteForUpdateSubscriptionContractDate`\n- **The subscription is prepaid with separate orders:** `allowEditQuantityPrepaidSeparatePlan` is `false`. The error key is `permissionDenied`\n- **A new variant isn't allowed:** the variant is in `disAllowVariantIdsForSubscriptionProductAdd`; or `allowProductIdsForSubscriptionProductAdd` isn't empty and holds neither the variant nor its product; or `productSelectionOption` is `PRODUCTS_FROM_ALL_PLANS` or `PRODUCTS_FROM_CURRENT_PLAN` and neither the variant nor its product is in a subscription plan. The error key is `productnotallowedforcustomerportal`\n\nAdmin API calls with an API key skip all of these checks. Storefront API calls ignore `newOneTimeVariants`, `oldOneTimeVariants` and `stopSwapEmails`: use the Subscription One-Time Products endpoints for one-time products.\n\n**Use Cases:**\n- Product upgrades/downgrades (e.g., switching coffee blend or size)\n- Quantity adjustments during product swap\n- Adding limited-time or seasonal products as one-time purchases (Admin API only)\n- Bulk product replacements for subscription migrations\n\n**Authentication:** Requires a signed-in customer. Call it through Shopify's App Proxy on the store's domain: the proxy signs the request and attaches the customer, so you send no API key.","operationId":"replaceVariantsV3","requestBody":"8ae9da0f-277d-4c1b-ad46-57595b502559","responses":{"200":"4d4d4da5-5fa1-4404-adfe-83f88586c5cd","400":"d71f6bf3-31bf-404b-bcfe-a2a456d29bec","401":"1ead7f61-fd29-4480-838f-efda89a69dc2","403":"d663261d-35ca-4387-8b46-1f254db138fa"},"summary":"Replace product variants in a subscription contract","tags":["Subscription Management","Subscription Contracts"],"method":"post","type":"path","servers":["8a345c8d-366b-4788-9cb9-8dc736cc9012"],"security":[],"path":"/subscriptions/cp/api/subscription-contract-details/replace-variants-v3","baseUrlOptions":["https://www.myshop.com/apps"],"title":"Replace product variants in a subscription contract","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","node","php","go","ruby"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"description":"Product replacement configuration for subscription contracts. Allows replacing existing subscription products with new ones, managing quantities, and handling one-time purchases.","properties":{"contractId":{"description":"The ID of the subscription contract to modify","example":123456789,"format":"int64","type":"integer","isRequired":true,"uniqueKey":"contractId","typeLabel":"integer\u003cint64>"},"carryForwardDiscount":{"deprecated":true,"description":"Ignored. The store's \"Discount policy for added products\" customer portal setting decides the discount on the new products.","enum":["NONE","EXISTING_PLAN","PRODUCT_PLAN","PRODUCT_THEN_EXISTING"],"type":"string","uniqueKey":"carryForwardDiscount","typeLabel":"enum\u003cstring>"},"newOneTimeVariants":{"additionalProperties":{"description":"Map of one-time product variant IDs to add with their quantities. These products will be charged only once with the next order and won't recur. Useful for add-ons, samples, or limited-time offers.","format":"int32","type":"integer","uniqueKey":"newOneTimeVariants.additionalProperties","typeLabel":"integer\u003cint32>"},"description":"Map of one-time product variant IDs to add with their quantities. These products will be charged only once with the next order and won't recur. Useful for add-ons, samples, or limited-time offers.","example":{"42549172066666":1,"42549172077777":2},"type":"object","uniqueKey":"newOneTimeVariants","typeLabel":"object"},"newVariants":{"additionalProperties":{"description":"Map of new variant IDs to their quantities. Key is the numeric Shopify variant ID, value is the desired quantity. If a variant already exists in the subscription and the system is configured to update existing quantities, the quantity will be added to the existing quantity.","format":"int32","type":"integer","uniqueKey":"newVariants.additionalProperties","typeLabel":"integer\u003cint32>"},"description":"Map of new variant IDs to their quantities. Key is the numeric Shopify variant ID, value is the desired quantity. If a variant already exists in the subscription and the system is configured to update existing quantities, the quantity will be added to the existing quantity.","example":{"42549172033333":2,"42549172044444":1},"type":"object","uniqueKey":"newVariants","typeLabel":"object"},"oldLineId":{"description":"Specific subscription line ID to replace. Use this for targeted replacement of a single line item. When provided, oldVariants should be empty. Format: gid://shopify/SubscriptionLine/[ID]","example":"gid://shopify/SubscriptionLine/987654321","type":"string","uniqueKey":"oldLineId","typeLabel":"string"},"oldOneTimeVariants":{"description":"List of one-time product variant IDs to remove from the subscription. Only removes one-time products that haven't been fulfilled yet.","example":[42549172055555,42549172088888],"items":{"description":"List of one-time product variant IDs to remove from the subscription. Only removes one-time products that haven't been fulfilled yet.","format":"int64","type":"integer","uniqueKey":"oldOneTimeVariants.items.[INDEX]","typeLabel":"integer\u003cint64>"},"type":"array","uniqueKey":"oldOneTimeVariants","typeLabel":"integer\u003cint64>[]"},"oldVariants":{"description":"List of variant IDs to remove from the subscription. These are numeric Shopify variant IDs. Either provide oldVariants OR oldLineId, not both.","example":[42549172011164,42549172022222],"items":{"description":"List of variant IDs to remove from the subscription. These are numeric Shopify variant IDs. Either provide oldVariants OR oldLineId, not both.","format":"int64","type":"integer","uniqueKey":"oldVariants.items.[INDEX]","typeLabel":"integer\u003cint64>"},"type":"array","uniqueKey":"oldVariants","typeLabel":"integer\u003cint64>[]"},"stopSwapEmails":{"default":false,"description":"If true, suppresses email notifications about the product swap. Default is false (emails will be sent).","example":false,"type":"boolean","uniqueKey":"stopSwapEmails","typeLabel":"boolean"}},"required":["contractId"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"contractId":123456789,"newOneTimeVariants":{"42549172066666":1,"42549172077777":2},"newVariants":{"42549172033333":2,"42549172044444":1},"oldLineId":"gid://shopify/SubscriptionLine/987654321","oldOneTimeVariants":[42549172055555,42549172088888],"oldVariants":[42549172011164,42549172022222],"stopSwapEmails":false}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"4d4d4da5-5fa1-4404-adfe-83f88586c5cd":{"content":{"application/json":{"examples":{"Success Response":{"title":"Success Response","description":"Success Response","value":{"id":"gid://shopify/SubscriptionContract/123456789","lines":{"nodes":[{"currentPrice":{"amount":"16.2","currencyCode":"USD"},"customAttributes":[{"key":"_appstle-bb-id","value":"k4n8tq2w"},{"key":"_appstle-bb-product-sku","value":null},{"key":"__appstle-bb-variants","value":"50000000000002:1"},{"key":"__appstle-bb-name","value":"Coffee Box"}],"id":"gid://shopify/SubscriptionLine/11111111-2222-4333-8444-555555555552","pricingPolicy":{"basePrice":{"amount":"18.0","currencyCode":"USD"},"cycleDiscounts":[{"adjustmentType":"PERCENTAGE","adjustmentValue":{"percentage":10},"afterCycle":0,"computedPrice":{"amount":"16.2","currencyCode":"USD"}}]},"productId":"gid://shopify/Product/9000000000002","quantity":1,"sellingPlanId":"gid://shopify/SellingPlan/800000000001","sellingPlanName":"Monthly Subscription","title":"Dark Roast Coffee","variantId":"gid://shopify/ProductVariant/50000000000002","variantTitle":null},{"currentPrice":{"amount":"19.8","currencyCode":"USD"},"customAttributes":[{"key":"_appstle-bb-id","value":"k4n8tq2w"},{"key":"__appstle-bb-name","value":"Coffee Box"},{"key":"__appstle-bb-variants","value":"50000000000001:1"},{"key":"_appstle-bb-product-sku","value":""}],"id":"gid://shopify/SubscriptionLine/11111111-2222-4333-8444-555555555553","pricingPolicy":{"basePrice":{"amount":"22.0","currencyCode":"USD"},"cycleDiscounts":[{"adjustmentType":"PERCENTAGE","adjustmentValue":{"percentage":10},"afterCycle":0,"computedPrice":{"amount":"19.8","currencyCode":"USD"}},{"adjustmentType":"PERCENTAGE","adjustmentValue":{"percentage":15},"afterCycle":3,"computedPrice":{"amount":"18.7","currencyCode":"USD"}}]},"productId":"gid://shopify/Product/9000000000003","quantity":1,"sellingPlanId":"gid://shopify/SellingPlan/800000000001","sellingPlanName":"Monthly Subscription","title":"Ethiopia Coffee","variantId":"gid://shopify/ProductVariant/50000000000003","variantTitle":null}],"pageInfo":{"hasNextPage":false,"hasPreviousPage":false}},"nextBillingDate":"2026-12-07T09:00:00Z","status":"ACTIVE"}}},"schema":{"properties":{"billingAttempts":{"properties":{"get__typename":{"type":"string","uniqueKey":"billingAttempts.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"completedAt":{"type":"object","uniqueKey":"billingAttempts.nodes.items.[INDEX].completedAt","typeLabel":"object"},"createdAt":{"type":"object","uniqueKey":"billingAttempts.nodes.items.[INDEX].createdAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"billingAttempts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"billingAttempts.nodes.items.[INDEX].id","typeLabel":"string"},"idempotencyKey":{"type":"string","uniqueKey":"billingAttempts.nodes.items.[INDEX].idempotencyKey","typeLabel":"string"},"ready":{"deprecated":true,"type":"boolean","uniqueKey":"billingAttempts.nodes.items.[INDEX].ready","typeLabel":"boolean"}},"type":"object","uniqueKey":"billingAttempts.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"billingAttempts.nodes","typeLabel":"object[]"}},"type":"object","uniqueKey":"billingAttempts","typeLabel":"object"},"billingPolicy":{"properties":{"anchors":{"items":{"properties":{"cutoffDay":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.anchors.items.[INDEX].cutoffDay","typeLabel":"integer\u003cint32>"},"day":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.anchors.items.[INDEX].day","typeLabel":"integer\u003cint32>"},"get__typename":{"type":"string","uniqueKey":"billingPolicy.anchors.items.[INDEX].get__typename","typeLabel":"string"},"month":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.anchors.items.[INDEX].month","typeLabel":"integer\u003cint32>"},"type":{"enum":["WEEKDAY","MONTHDAY","YEARDAY","$UNKNOWN"],"type":"string","uniqueKey":"billingPolicy.anchors.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"billingPolicy.anchors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"billingPolicy.anchors","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"billingPolicy.get__typename","typeLabel":"string"},"interval":{"enum":["DAY","WEEK","MONTH","YEAR","$UNKNOWN"],"type":"string","uniqueKey":"billingPolicy.interval","typeLabel":"enum\u003cstring>"},"intervalCount":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.intervalCount","typeLabel":"integer\u003cint32>"},"maxCycles":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.maxCycles","typeLabel":"integer\u003cint32>"},"minCycles":{"format":"int32","type":"integer","uniqueKey":"billingPolicy.minCycles","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"billingPolicy","typeLabel":"object"},"createdAt":{"type":"object","uniqueKey":"createdAt","typeLabel":"object"},"customAttributes":{"items":{"properties":{"get__typename":{"type":"string","uniqueKey":"customAttributes.items.[INDEX].get__typename","typeLabel":"string"},"key":{"type":"string","uniqueKey":"customAttributes.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","uniqueKey":"customAttributes.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"customAttributes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"customAttributes","typeLabel":"object[]"},"customer":{"properties":{"displayName":{"type":"string","uniqueKey":"customer.displayName","typeLabel":"string"},"email":{"deprecated":true,"type":"string","uniqueKey":"customer.email","typeLabel":"string"},"firstName":{"type":"string","uniqueKey":"customer.firstName","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"customer.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"customer.id","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"customer.lastName","typeLabel":"string"},"phone":{"deprecated":true,"type":"string","uniqueKey":"customer.phone","typeLabel":"string"}},"type":"object","uniqueKey":"customer","typeLabel":"object"},"customerPaymentMethod":{"properties":{"get__typename":{"type":"string","uniqueKey":"customerPaymentMethod.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"customerPaymentMethod.id","typeLabel":"string"},"instrument":{"properties":{"get__typename":{"type":"string","uniqueKey":"customerPaymentMethod.instrument.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"customerPaymentMethod.instrument","typeLabel":"object"},"revokedAt":{"type":"object","uniqueKey":"customerPaymentMethod.revokedAt","typeLabel":"object"},"revokedReason":{"enum":["AUTHORIZE_NET_GATEWAY_NOT_ENABLED","AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD","FAILED_TO_UPDATE_CREDIT_CARD","STRIPE_API_AUTHENTICATION_ERROR","STRIPE_API_INVALID_REQUEST_ERROR","STRIPE_GATEWAY_NOT_ENABLED","STRIPE_RETURNED_NO_PAYMENT_METHOD","STRIPE_PAYMENT_METHOD_NOT_CARD","BRAINTREE_API_AUTHENTICATION_ERROR","BRAINTREE_GATEWAY_NOT_ENABLED","BRAINTREE_RETURNED_NO_PAYMENT_METHOD","BRAINTREE_PAYMENT_METHOD_NOT_CARD","PAYMENT_METHOD_VERIFICATION_FAILED","THREE_D_SECURE_FLOW_IN_VERIFICATION_NOT_IMPLEMENTED","MANUALLY_REVOKED","FAILED_TO_RETRIEVE_BILLING_ADDRESS","MERGED","CUSTOMER_REDACTED","TOO_MANY_CONSECUTIVE_FAILURES","CVV_ATTEMPTS_LIMIT_EXCEEDED","$UNKNOWN"],"type":"string","uniqueKey":"customerPaymentMethod.revokedReason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"customerPaymentMethod","typeLabel":"object"},"deliveryMethod":{"properties":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod","typeLabel":"object"},"deliveryPolicy":{"properties":{"anchors":{"items":{"properties":{"cutoffDay":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].cutoffDay","typeLabel":"integer\u003cint32>"},"day":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].day","typeLabel":"integer\u003cint32>"},"get__typename":{"type":"string","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].get__typename","typeLabel":"string"},"month":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].month","typeLabel":"integer\u003cint32>"},"type":{"enum":["WEEKDAY","MONTHDAY","YEARDAY","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"deliveryPolicy.anchors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"deliveryPolicy.anchors","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"deliveryPolicy.get__typename","typeLabel":"string"},"interval":{"enum":["DAY","WEEK","MONTH","YEAR","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPolicy.interval","typeLabel":"enum\u003cstring>"},"intervalCount":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.intervalCount","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"deliveryPolicy","typeLabel":"object"},"deliveryPrice":{"properties":{"amount":{"type":"object","uniqueKey":"deliveryPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"deliveryPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryPrice","typeLabel":"object"},"discounts":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].id","typeLabel":"string"},"recurringCycleLimit":{"format":"int32","type":"integer","uniqueKey":"discounts.nodes.items.[INDEX].recurringCycleLimit","typeLabel":"integer\u003cint32>"},"rejectionReason":{"enum":["NOT_FOUND","NO_ENTITLED_LINE_ITEMS","QUANTITY_NOT_IN_RANGE","PURCHASE_NOT_IN_RANGE","CUSTOMER_NOT_ELIGIBLE","USAGE_LIMIT_REACHED","CUSTOMER_USAGE_LIMIT_REACHED","CURRENTLY_INACTIVE","NO_ENTITLED_SHIPPING_LINES","INCOMPATIBLE_PURCHASE_TYPE","INTERNAL_ERROR","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].rejectionReason","typeLabel":"enum\u003cstring>"},"targetType":{"enum":["LINE_ITEM","SHIPPING_LINE","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].targetType","typeLabel":"enum\u003cstring>"},"title":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["MANUAL","CODE_DISCOUNT","AUTOMATIC_DISCOUNT","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"usageCount":{"format":"int32","type":"integer","uniqueKey":"discounts.nodes.items.[INDEX].usageCount","typeLabel":"integer\u003cint32>"},"value":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].value.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].value","typeLabel":"object"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"discounts.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"discounts.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"discounts.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"discounts.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"discounts.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"discounts.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"discounts.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"discounts","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"lastPaymentStatus":{"enum":["SUCCEEDED","FAILED","$UNKNOWN"],"type":"string","uniqueKey":"lastPaymentStatus","typeLabel":"enum\u003cstring>"},"lines":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"currentPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].currentPrice","typeLabel":"object"},"customAttributes":{"items":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].get__typename","typeLabel":"string"},"key":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].customAttributes","typeLabel":"object[]"},"discountAllocations":{"items":{"properties":{"amount":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount","typeLabel":"object"},"discount":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].discount.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].discount","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].id","typeLabel":"string"},"lineDiscountedPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice","typeLabel":"object"},"pricingPolicy":{"properties":{"basePrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice","typeLabel":"object"},"cycleDiscounts":{"items":{"properties":{"adjustmentType":{"enum":["PERCENTAGE","FIXED_AMOUNT","PRICE","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentType","typeLabel":"enum\u003cstring>"},"adjustmentValue":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentValue.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentValue","typeLabel":"object"},"afterCycle":{"format":"int32","type":"integer","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].afterCycle","typeLabel":"integer\u003cint32>"},"computedPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy","typeLabel":"object"},"productId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].productId","typeLabel":"string"},"quantity":{"format":"int32","type":"integer","uniqueKey":"lines.nodes.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"sellingPlanId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sellingPlanId","typeLabel":"string"},"sellingPlanName":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sellingPlanName","typeLabel":"string"},"sku":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sku","typeLabel":"string"},"taxable":{"type":"boolean","uniqueKey":"lines.nodes.items.[INDEX].taxable","typeLabel":"boolean"},"title":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].title","typeLabel":"string"},"variantId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantId","typeLabel":"string"},"variantImage":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantImage.get__typename","typeLabel":"string"},"url":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].variantImage.url","typeLabel":"object"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].variantImage","typeLabel":"object"},"variantTitle":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantTitle","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"lines.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"lines.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"lines.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"lines.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"lines.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"lines.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"lines","typeLabel":"object"},"nextBillingDate":{"type":"object","uniqueKey":"nextBillingDate","typeLabel":"object"},"note":{"type":"string","uniqueKey":"note","typeLabel":"string"},"originOrder":{"properties":{"fulfillmentOrders":{"properties":{"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"fulfillAt":{"type":"object","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].fulfillAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].id","typeLabel":"string"},"status":{"enum":["OPEN","IN_PROGRESS","CANCELLED","INCOMPLETE","CLOSED","SCHEDULED","ON_HOLD","$UNKNOWN"],"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"originOrder.fulfillmentOrders.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"originOrder.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"originOrder.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"originOrder.name","typeLabel":"string"}},"type":"object","uniqueKey":"originOrder","typeLabel":"object"},"revisionId":{"type":"object","uniqueKey":"revisionId","typeLabel":"object"},"status":{"enum":["ACTIVE","PAUSED","CANCELLED","EXPIRED","FAILED","$UNKNOWN"],"type":"string","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"object","uniqueKey":"updatedAt","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Products successfully replaced","exampleType":"examples"},"d71f6bf3-31bf-404b-bcfe-a2a456d29bec":{"content":{"application/problem+json":{"examples":{"Below Minimum Order Value":{"title":"Below Minimum Order Value","description":"Below Minimum Order Value","value":{"errorKey":"minOrderValueNotMet","message":"UserGeneratedError: Minimum order value required is 500.00, but order total would become 54.40.","params":"","status":400,"title":"UserGeneratedError: Minimum order value required is 500.00, but order total would become 54.40.","type":"https://appstle.com/problem/problem-with-message"}},"Below Minimum Quantity (Storefront API)":{"title":"Below Minimum Quantity (Storefront API)","description":"Below Minimum Quantity (Storefront API)","value":{"message":"UserGeneratedError:Minimum quantity requirement not met: You must add at least 1 item(s) to proceed.","params":"","status":400,"title":"UserGeneratedError:Minimum quantity requirement not met: You must add at least 1 item(s) to proceed.","type":"https://appstle.com/problem/problem-with-message"}},"Contract Not Found":{"title":"Contract Not Found","description":"Contract Not Found","value":{"errorKey":"invalidContract","message":"Contract does not exist","params":"","status":400,"title":"Contract does not exist","type":"https://appstle.com/problem/problem-with-message"}},"Line Not Found":{"title":"Line Not Found","description":"Line Not Found","value":{"entityName":"subscriptionContractDetails","message":"Contract line not found for id: gid://shopify/SubscriptionLine/11111111-2222-4333-8444-555555555551","params":"subscriptionContractDetails","status":400,"title":"Contract line not found for id: gid://shopify/SubscriptionLine/11111111-2222-4333-8444-555555555551","type":"https://appstle.com/problem/problem-with-message"}},"No Variants Specified (Storefront API)":{"title":"No Variants Specified (Storefront API)","description":"No Variants Specified (Storefront API)","value":{"entityName":"subscriptionContractDetails","errorKey":"idnull","message":"UserGeneratedError:No variants to add or remove","params":"subscriptionContractDetails","status":400,"title":"UserGeneratedError:No variants to add or remove","type":"https://appstle.com/problem/problem-with-message"}},"Old Variant Not in the Contract":{"title":"Old Variant Not in the Contract","description":"Old Variant Not in the Contract","value":{"entityName":"subscriptionContractDetails","errorKey":"idnull","message":"UserGeneratedError:Old variants didn't match with the existing variants","params":"subscriptionContractDetails","status":400,"title":"UserGeneratedError:Old variants didn't match with the existing variants","type":"https://appstle.com/problem/problem-with-message"}},"Same Source and Destination":{"title":"Same Source and Destination","description":"Same Source and Destination","value":{"entityName":"subscriptionContractDetails","errorKey":"idnull","message":"UserGeneratedError:Source and destination variants cannot be same","params":"subscriptionContractDetails","status":400,"title":"UserGeneratedError:Source and destination variants cannot be same","type":"https://appstle.com/problem/problem-with-message"}},"Swapping Turned Off (Storefront API)":{"title":"Swapping Turned Off (Storefront API)","description":"Swapping Turned Off (Storefront API)","value":{"entityName":"swapProductVariant","message":"UserGeneratedError:Permission denied, Subscription cannot be modified","params":"swapProductVariant","status":400,"title":"UserGeneratedError:Permission denied, Subscription cannot be modified","type":"https://appstle.com/problem/problem-with-message"}},"Variant Not Allowed (Storefront API)":{"title":"Variant Not Allowed (Storefront API)","description":"Variant Not Allowed (Storefront API)","value":{"entityName":"subscriptionContractDetails","errorKey":"productnotallowedforcustomerportal","message":"UserGeneratedError:This product is not available for this subscription.","params":"subscriptionContractDetails","status":400,"title":"UserGeneratedError:This product is not available for this subscription.","type":"https://appstle.com/problem/problem-with-message"}}},"exampleType":"examples"}},"description":"The change can't be made. A new variant whose price can't be determined returns the error key `unreliableReplacementPrice` and changes nothing. Storefront API calls also return a 400 for the customer portal settings listed under **Storefront API calls**.","exampleType":"examples"},"1ead7f61-fd29-4480-838f-efda89a69dc2":{"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":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod","typeLabel":"object"},"deliveryPolicy":{"properties":{"anchors":{"items":{"properties":{"cutoffDay":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].cutoffDay","typeLabel":"integer\u003cint32>"},"day":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].day","typeLabel":"integer\u003cint32>"},"get__typename":{"type":"string","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].get__typename","typeLabel":"string"},"month":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].month","typeLabel":"integer\u003cint32>"},"type":{"enum":["WEEKDAY","MONTHDAY","YEARDAY","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"deliveryPolicy.anchors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"deliveryPolicy.anchors","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"deliveryPolicy.get__typename","typeLabel":"string"},"interval":{"enum":["DAY","WEEK","MONTH","YEAR","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPolicy.interval","typeLabel":"enum\u003cstring>"},"intervalCount":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.intervalCount","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"deliveryPolicy","typeLabel":"object"},"deliveryPrice":{"properties":{"amount":{"type":"object","uniqueKey":"deliveryPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"deliveryPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryPrice","typeLabel":"object"},"discounts":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].id","typeLabel":"string"},"recurringCycleLimit":{"format":"int32","type":"integer","uniqueKey":"discounts.nodes.items.[INDEX].recurringCycleLimit","typeLabel":"integer\u003cint32>"},"rejectionReason":{"enum":["NOT_FOUND","NO_ENTITLED_LINE_ITEMS","QUANTITY_NOT_IN_RANGE","PURCHASE_NOT_IN_RANGE","CUSTOMER_NOT_ELIGIBLE","USAGE_LIMIT_REACHED","CUSTOMER_USAGE_LIMIT_REACHED","CURRENTLY_INACTIVE","NO_ENTITLED_SHIPPING_LINES","INCOMPATIBLE_PURCHASE_TYPE","INTERNAL_ERROR","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].rejectionReason","typeLabel":"enum\u003cstring>"},"targetType":{"enum":["LINE_ITEM","SHIPPING_LINE","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].targetType","typeLabel":"enum\u003cstring>"},"title":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["MANUAL","CODE_DISCOUNT","AUTOMATIC_DISCOUNT","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"usageCount":{"format":"int32","type":"integer","uniqueKey":"discounts.nodes.items.[INDEX].usageCount","typeLabel":"integer\u003cint32>"},"value":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].value.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].value","typeLabel":"object"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"discounts.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"discounts.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"discounts.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"discounts.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"discounts.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"discounts.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"discounts.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"discounts","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"lastPaymentStatus":{"enum":["SUCCEEDED","FAILED","$UNKNOWN"],"type":"string","uniqueKey":"lastPaymentStatus","typeLabel":"enum\u003cstring>"},"lines":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"currentPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].currentPrice","typeLabel":"object"},"customAttributes":{"items":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].get__typename","typeLabel":"string"},"key":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].customAttributes","typeLabel":"object[]"},"discountAllocations":{"items":{"properties":{"amount":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount","typeLabel":"object"},"discount":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].discount.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].discount","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].id","typeLabel":"string"},"lineDiscountedPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice","typeLabel":"object"},"pricingPolicy":{"properties":{"basePrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice","typeLabel":"object"},"cycleDiscounts":{"items":{"properties":{"adjustmentType":{"enum":["PERCENTAGE","FIXED_AMOUNT","PRICE","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentType","typeLabel":"enum\u003cstring>"},"adjustmentValue":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentValue.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentValue","typeLabel":"object"},"afterCycle":{"format":"int32","type":"integer","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].afterCycle","typeLabel":"integer\u003cint32>"},"computedPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy","typeLabel":"object"},"productId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].productId","typeLabel":"string"},"quantity":{"format":"int32","type":"integer","uniqueKey":"lines.nodes.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"sellingPlanId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sellingPlanId","typeLabel":"string"},"sellingPlanName":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sellingPlanName","typeLabel":"string"},"sku":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sku","typeLabel":"string"},"taxable":{"type":"boolean","uniqueKey":"lines.nodes.items.[INDEX].taxable","typeLabel":"boolean"},"title":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].title","typeLabel":"string"},"variantId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantId","typeLabel":"string"},"variantImage":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantImage.get__typename","typeLabel":"string"},"url":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].variantImage.url","typeLabel":"object"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].variantImage","typeLabel":"object"},"variantTitle":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantTitle","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"lines.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"lines.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"lines.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"lines.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"lines.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"lines.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"lines","typeLabel":"object"},"nextBillingDate":{"type":"object","uniqueKey":"nextBillingDate","typeLabel":"object"},"note":{"type":"string","uniqueKey":"note","typeLabel":"string"},"originOrder":{"properties":{"fulfillmentOrders":{"properties":{"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"fulfillAt":{"type":"object","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].fulfillAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].id","typeLabel":"string"},"status":{"enum":["OPEN","IN_PROGRESS","CANCELLED","INCOMPLETE","CLOSED","SCHEDULED","ON_HOLD","$UNKNOWN"],"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"originOrder.fulfillmentOrders.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"originOrder.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"originOrder.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"originOrder.name","typeLabel":"string"}},"type":"object","uniqueKey":"originOrder","typeLabel":"object"},"revisionId":{"type":"object","uniqueKey":"revisionId","typeLabel":"object"},"status":{"enum":["ACTIVE","PAUSED","CANCELLED","EXPIRED","FAILED","$UNKNOWN"],"type":"string","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"object","uniqueKey":"updatedAt","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"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":{"get__typename":"\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":[{"get__typename":"\u003cstring>","id":"\u003cstring>","recurringCycleLimit":123,"rejectionReason":"NOT_FOUND","targetType":"LINE_ITEM","title":"\u003cstring>","type":"MANUAL","usageCount":123,"value":{"get__typename":"\u003cstring>"}}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","lastPaymentStatus":"SUCCEEDED","lines":{"get__typename":"\u003cstring>","nodes":[{"currentPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"customAttributes":[{"get__typename":"\u003cstring>","key":"\u003cstring>","value":"\u003cstring>"}],"discountAllocations":[{"amount":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"discount":{"get__typename":"\u003cstring>"},"get__typename":"\u003cstring>"}],"get__typename":"\u003cstring>","id":"\u003cstring>","lineDiscountedPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"pricingPolicy":{"basePrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"cycleDiscounts":[{"adjustmentType":"PERCENTAGE","adjustmentValue":{"get__typename":"\u003cstring>"},"afterCycle":123,"computedPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"get__typename":"\u003cstring>"}],"get__typename":"\u003cstring>"},"productId":"\u003cstring>","quantity":123,"sellingPlanId":"\u003cstring>","sellingPlanName":"\u003cstring>","sku":"\u003cstring>","taxable":true,"title":"\u003cstring>","variantId":"\u003cstring>","variantImage":{"get__typename":"\u003cstring>","url":{}},"variantTitle":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"nextBillingDate":{},"note":"\u003cstring>","originOrder":{"fulfillmentOrders":{"get__typename":"\u003cstring>","nodes":[{"fulfillAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","status":"OPEN"}],"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":"Not authenticated - the request didn't come through the App Proxy, or no customer is signed in","exampleType":"generated"},"d663261d-35ca-4387-8b46-1f254db138fa":{"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":{"get__typename":{"type":"string","uniqueKey":"deliveryMethod.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryMethod","typeLabel":"object"},"deliveryPolicy":{"properties":{"anchors":{"items":{"properties":{"cutoffDay":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].cutoffDay","typeLabel":"integer\u003cint32>"},"day":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].day","typeLabel":"integer\u003cint32>"},"get__typename":{"type":"string","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].get__typename","typeLabel":"string"},"month":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].month","typeLabel":"integer\u003cint32>"},"type":{"enum":["WEEKDAY","MONTHDAY","YEARDAY","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPolicy.anchors.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"deliveryPolicy.anchors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"deliveryPolicy.anchors","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"deliveryPolicy.get__typename","typeLabel":"string"},"interval":{"enum":["DAY","WEEK","MONTH","YEAR","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPolicy.interval","typeLabel":"enum\u003cstring>"},"intervalCount":{"format":"int32","type":"integer","uniqueKey":"deliveryPolicy.intervalCount","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"deliveryPolicy","typeLabel":"object"},"deliveryPrice":{"properties":{"amount":{"type":"object","uniqueKey":"deliveryPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"deliveryPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"deliveryPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"deliveryPrice","typeLabel":"object"},"discounts":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].id","typeLabel":"string"},"recurringCycleLimit":{"format":"int32","type":"integer","uniqueKey":"discounts.nodes.items.[INDEX].recurringCycleLimit","typeLabel":"integer\u003cint32>"},"rejectionReason":{"enum":["NOT_FOUND","NO_ENTITLED_LINE_ITEMS","QUANTITY_NOT_IN_RANGE","PURCHASE_NOT_IN_RANGE","CUSTOMER_NOT_ELIGIBLE","USAGE_LIMIT_REACHED","CUSTOMER_USAGE_LIMIT_REACHED","CURRENTLY_INACTIVE","NO_ENTITLED_SHIPPING_LINES","INCOMPATIBLE_PURCHASE_TYPE","INTERNAL_ERROR","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].rejectionReason","typeLabel":"enum\u003cstring>"},"targetType":{"enum":["LINE_ITEM","SHIPPING_LINE","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].targetType","typeLabel":"enum\u003cstring>"},"title":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].title","typeLabel":"string"},"type":{"enum":["MANUAL","CODE_DISCOUNT","AUTOMATIC_DISCOUNT","$UNKNOWN"],"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"usageCount":{"format":"int32","type":"integer","uniqueKey":"discounts.nodes.items.[INDEX].usageCount","typeLabel":"integer\u003cint32>"},"value":{"properties":{"get__typename":{"type":"string","uniqueKey":"discounts.nodes.items.[INDEX].value.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX].value","typeLabel":"object"}},"type":"object","uniqueKey":"discounts.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"discounts.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"discounts.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"discounts.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"discounts.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"discounts.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"discounts.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"discounts.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"discounts","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"lastPaymentStatus":{"enum":["SUCCEEDED","FAILED","$UNKNOWN"],"type":"string","uniqueKey":"lastPaymentStatus","typeLabel":"enum\u003cstring>"},"lines":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"currentPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].currentPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].currentPrice","typeLabel":"object"},"customAttributes":{"items":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].get__typename","typeLabel":"string"},"key":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].customAttributes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].customAttributes","typeLabel":"object[]"},"discountAllocations":{"items":{"properties":{"amount":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].amount","typeLabel":"object"},"discount":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].discount.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].discount","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX].get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].discountAllocations","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].id","typeLabel":"string"},"lineDiscountedPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].lineDiscountedPrice","typeLabel":"object"},"pricingPolicy":{"properties":{"basePrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.basePrice","typeLabel":"object"},"cycleDiscounts":{"items":{"properties":{"adjustmentType":{"enum":["PERCENTAGE","FIXED_AMOUNT","PRICE","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentType","typeLabel":"enum\u003cstring>"},"adjustmentValue":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentValue.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].adjustmentValue","typeLabel":"object"},"afterCycle":{"format":"int32","type":"integer","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].afterCycle","typeLabel":"integer\u003cint32>"},"computedPrice":{"properties":{"amount":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.amount","typeLabel":"object"},"currencyCode":{"enum":["USD","EUR","GBP","CAD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AUD","BBD","AZN","BDT","BSD","BHD","BIF","BYN","BZD","BMD","BTN","BAM","BRL","BOB","BWP","BND","BGN","MMK","KHR","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CZK","DKK","DJF","DOP","XCD","EGP","ERN","ETB","FKP","XPF","FJD","GIP","GMD","GHS","GTQ","GYD","GEL","GNF","HTG","HNL","HKD","HUF","ISK","INR","IDR","ILS","IRR","IQD","JMD","JPY","JEP","JOD","KZT","KES","KID","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MGA","MKD","MOP","MWK","MVR","MRU","MXN","MYR","MUR","MDL","MAD","MNT","MZN","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PAB","PKR","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","SHP","SAR","RSD","SCR","SLL","SGD","SDG","SOS","SYP","ZAR","KRW","SSP","SBD","LKR","SRD","SZL","SEK","CHF","TWD","THB","TJS","TZS","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","UYU","UZS","VUV","VES","VND","XOF","YER","ZMW","USDC","BYR","STD","STN","VED","VEF","XXX","$UNKNOWN"],"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.currencyCode","typeLabel":"enum\u003cstring>"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].computedPrice","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX].get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.cycleDiscounts","typeLabel":"object[]"},"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy.get__typename","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].pricingPolicy","typeLabel":"object"},"productId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].productId","typeLabel":"string"},"quantity":{"format":"int32","type":"integer","uniqueKey":"lines.nodes.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"sellingPlanId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sellingPlanId","typeLabel":"string"},"sellingPlanName":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sellingPlanName","typeLabel":"string"},"sku":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].sku","typeLabel":"string"},"taxable":{"type":"boolean","uniqueKey":"lines.nodes.items.[INDEX].taxable","typeLabel":"boolean"},"title":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].title","typeLabel":"string"},"variantId":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantId","typeLabel":"string"},"variantImage":{"properties":{"get__typename":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantImage.get__typename","typeLabel":"string"},"url":{"type":"object","uniqueKey":"lines.nodes.items.[INDEX].variantImage.url","typeLabel":"object"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX].variantImage","typeLabel":"object"},"variantTitle":{"type":"string","uniqueKey":"lines.nodes.items.[INDEX].variantTitle","typeLabel":"string"}},"type":"object","uniqueKey":"lines.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"lines.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"lines.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"lines.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"lines.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"lines.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"lines.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"lines.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"lines","typeLabel":"object"},"nextBillingDate":{"type":"object","uniqueKey":"nextBillingDate","typeLabel":"object"},"note":{"type":"string","uniqueKey":"note","typeLabel":"string"},"originOrder":{"properties":{"fulfillmentOrders":{"properties":{"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.get__typename","typeLabel":"string"},"nodes":{"items":{"properties":{"fulfillAt":{"type":"object","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].fulfillAt","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].id","typeLabel":"string"},"status":{"enum":["OPEN","IN_PROGRESS","CANCELLED","INCOMPLETE","CLOSED","SCHEDULED","ON_HOLD","$UNKNOWN"],"type":"string","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders.nodes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"originOrder.fulfillmentOrders.nodes","typeLabel":"object[]"},"pageInfo":{"properties":{"endCursor":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.endCursor","typeLabel":"string"},"get__typename":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.get__typename","typeLabel":"string"},"hasNextPage":{"type":"boolean","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.hasNextPage","typeLabel":"boolean"},"hasPreviousPage":{"type":"boolean","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.hasPreviousPage","typeLabel":"boolean"},"startCursor":{"type":"string","uniqueKey":"originOrder.fulfillmentOrders.pageInfo.startCursor","typeLabel":"string"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders.pageInfo","typeLabel":"object"}},"type":"object","uniqueKey":"originOrder.fulfillmentOrders","typeLabel":"object"},"get__typename":{"type":"string","uniqueKey":"originOrder.get__typename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"originOrder.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"originOrder.name","typeLabel":"string"}},"type":"object","uniqueKey":"originOrder","typeLabel":"object"},"revisionId":{"type":"object","uniqueKey":"revisionId","typeLabel":"object"},"status":{"enum":["ACTIVE","PAUSED","CANCELLED","EXPIRED","FAILED","$UNKNOWN"],"type":"string","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"object","uniqueKey":"updatedAt","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"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":{"get__typename":"\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":[{"get__typename":"\u003cstring>","id":"\u003cstring>","recurringCycleLimit":123,"rejectionReason":"NOT_FOUND","targetType":"LINE_ITEM","title":"\u003cstring>","type":"MANUAL","usageCount":123,"value":{"get__typename":"\u003cstring>"}}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"get__typename":"\u003cstring>","id":"\u003cstring>","lastPaymentStatus":"SUCCEEDED","lines":{"get__typename":"\u003cstring>","nodes":[{"currentPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"customAttributes":[{"get__typename":"\u003cstring>","key":"\u003cstring>","value":"\u003cstring>"}],"discountAllocations":[{"amount":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"discount":{"get__typename":"\u003cstring>"},"get__typename":"\u003cstring>"}],"get__typename":"\u003cstring>","id":"\u003cstring>","lineDiscountedPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"pricingPolicy":{"basePrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"cycleDiscounts":[{"adjustmentType":"PERCENTAGE","adjustmentValue":{"get__typename":"\u003cstring>"},"afterCycle":123,"computedPrice":{"amount":{},"currencyCode":"USD","get__typename":"\u003cstring>"},"get__typename":"\u003cstring>"}],"get__typename":"\u003cstring>"},"productId":"\u003cstring>","quantity":123,"sellingPlanId":"\u003cstring>","sellingPlanName":"\u003cstring>","sku":"\u003cstring>","taxable":true,"title":"\u003cstring>","variantId":"\u003cstring>","variantImage":{"get__typename":"\u003cstring>","url":{}},"variantTitle":"\u003cstring>"}],"pageInfo":{"endCursor":"\u003cstring>","get__typename":"\u003cstring>","hasNextPage":true,"hasPreviousPage":true,"startCursor":"\u003cstring>"}},"nextBillingDate":{},"note":"\u003cstring>","originOrder":{"fulfillmentOrders":{"get__typename":"\u003cstring>","nodes":[{"fulfillAt":{},"get__typename":"\u003cstring>","id":"\u003cstring>","status":"OPEN"}],"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":"Insufficient permissions to modify subscription contracts","exampleType":"generated"}},"security":{},"servers":{"8a345c8d-366b-4788-9cb9-8dc736cc9012":{"url":"https://www.myshop.com/apps"}}},"originalFileLocation":"subscription/storefront-api-swagger.json"},"subdomain":"appstleinc-aeca3e0a","siteName":"Appstle","title":"Replace product variants in a subscription contract - Appstle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-22T01:44:32.965Z","originalFileLocation":"subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Replaces existing product variants with new ones in a subscription contract, so you can swap products and change quantities. On the Admin API, the same call can also add and remove one-time products. Key Features: - Bulk Replace: Replace multiple products at once by providing lists of old and new variants - Line-Specific Replace: Target a specific line item using oldLineId for precise replacement - Quantity Management: Set new quantities for replaced products - One-Time Products (Admin API only): Add or remove one-time purchase products with newOneTimeVariants and oldOneTimeVariants - Discounts: The store\u0026#x27;s customer portal setting decides the new products\u0026#x27; discount (see below) Discounts on the new products: The store\u0026#x27;s Discount policy for added products setting decides which discount the new products get, on both the Admin API and the Storefront API. The request body\u0026#x27;s carryForwardDiscount field is ignored. Merchants choose the policy in the Appstle Subscriptions app under Customer Portal: in Portal Editor → Settings → More rules → Discounts on added products, or, on stores without the Portal Editor, in Configuration → Order \u0026amp; Subscription Management. The default is the first option: - Use product\u0026#x27;s plan first, then current subscription discount (PRODUCT_THEN_EXISTING): a product in a plan with the same order frequency as this subscription gets that plan\u0026#x27;s discount. Other products, and products whose matching plan has no discount, get the subscription\u0026#x27;s current discount - Apply product\u0026#x27;s own subscription discount (PRODUCT_PLAN): a product in a plan with the same order frequency as this subscription gets that plan\u0026#x27;s discount. Other products get no discount - Apply current subscription discount (EXISTING_PLAN): the new products get the same discount as the subscription\u0026#x27;s existing items, including manual price adjustments - No discount on added products (NONE): the new products are charged at their regular price On a prepaid subscription that ships as separate orders, the new products always get EXISTING_PLAN pricing, whatever the setting. Important Notes: - One-time and free product lines can\u0026#x27;t be replaced. These lines carry the _appstle-one-time-product attribute, or _appstle-free-product set to true. Passing such a line\u0026#x27;s variant in oldVariants, or its ID as oldLineId, returns a 400. On the Admin API, remove a one-time line with oldOneTimeVariants instead - The replacement line gets a new id, so take line IDs from the latest response. An oldLineId that isn\u0026#x27;t on the contract returns a 400 - The merchant\u0026#x27;s minimum order value applies to both APIs. If the products\u0026#x27; total after the change would be below minOrderValue in the customer portal settings, the call returns a 400 with the error key minOrderValueNotMet - On the Admin API, a request whose oldVariants, newVariants, oldLineId, newOneTimeVariants and oldOneTimeVariants are all empty or missing changes nothing and returns a 200 with an empty body - On a prepaid subscription, the new line\u0026#x27;s price covers all the deliveries in one billing period - The shipping price is recalculated in the background after the change, unless the merchant turned off automatic shipping price calculation or set a custom delivery price on the subscription Storefront API calls: When a signed-in customer makes this call through the Storefront API, the merchant\u0026#x27;s customer portal settings apply. Merchants set them in the Appstle Subscriptions app under Customer Portal. Read them from Get customer portal settings and offer only the changes they allow. The call returns a 400 when: - Swapping is turned off: enableSwapProductFeature and enableSwapProductVariant are both false. The response has no errorKey, and its entityName is swapProductVariant. Offer swapping only when one of them is true - A quantity is below the minimum: a quantity in newVariants is lower than minQtyToAllowDuringAddProduct. The response has no errorKey - The subscription is locked until its minimum cycles: freezeOrderTillMinCycle is true, allowSwapWhenContractIsFreeze isn\u0026#x27;t true, and the subscription hasn\u0026#x27;t reached its minimum number of billing cycles. The message is the merchant\u0026#x27;s freezeUpdateSubscriptionMessage, and the error key is minCycleNotCompleteForUpdateSubscriptionContractDate - The subscription is prepaid with separate orders: allowEditQuantityPrepaidSeparatePlan is false. The error key is permissionDenied - A new variant isn\u0026#x27;t allowed: the variant is in disAllowVariantIdsForSubscriptionProductAdd; or allowProductIdsForSubscriptionProductAdd isn\u0026#x27;t empty and holds neither the variant nor its product; or productSelectionOption is PRODUCTS_FROM_ALL_PLANS or PRODUCTS_FROM_CURRENT_PLAN and neither the variant nor its product is in a subscription plan. The error key is productnotallowedforcustomerportal Admin API calls with an API key skip all of these checks. Storefront API calls ignore newOneTimeVariants, oldOneTimeVariants and stopSwapEmails: use the Subscription One-Time Products endpoints for one-time products. Use Cases: - Product upgrades/downgrades (e.g., switching coffee blend or size) - Quantity adjustments during product swap - Adding limited-time or seasonal products as one-time purchases (Admin API only) - Bulk product replacements for subscription migrations Authentication: Requires a signed-in customer. Call it through Shopify\u0026#x27;s App Proxy on the store\u0026#x27;s domain: the proxy signs the request and attaches the customer, so you send no API key.\">\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=\"Replace product variants in a subscription contract - Appstle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Replaces existing product variants with new ones in a subscription contract, so you can swap products and change quantities. On the Admin API, the same call can also add and remove one-time products. Key Features: - Bulk Replace: Replace multiple products at once by providing lists of old and new variants - Line-Specific Replace: Target a specific line item using oldLineId for precise replacement - Quantity Management: Set new quantities for replaced products - One-Time Products (Admin API only): Add or remove one-time purchase products with newOneTimeVariants and oldOneTimeVariants - Discounts: The store\u0026#x27;s customer portal setting decides the new products\u0026#x27; discount (see below) Discounts on the new products: The store\u0026#x27;s Discount policy for added products setting decides which discount the new products get, on both the Admin API and the Storefront API. The request body\u0026#x27;s carryForwardDiscount field is ignored. Merchants choose the policy in the Appstle Subscriptions app under Customer Portal: in Portal Editor → Settings → More rules → Discounts on added products, or, on stores without the Portal Editor, in Configuration → Order \u0026amp; Subscription Management. The default is the first option: - Use product\u0026#x27;s plan first, then current subscription discount (PRODUCT_THEN_EXISTING): a product in a plan with the same order frequency as this subscription gets that plan\u0026#x27;s discount. Other products, and products whose matching plan has no discount, get the subscription\u0026#x27;s current discount - Apply product\u0026#x27;s own subscription discount (PRODUCT_PLAN): a product in a plan with the same order frequency as this subscription gets that plan\u0026#x27;s discount. Other products get no discount - Apply current subscription discount (EXISTING_PLAN): the new products get the same discount as the subscription\u0026#x27;s existing items, including manual price adjustments - No discount on added products (NONE): the new products are charged at their regular price On a prepaid subscription that ships as separate orders, the new products always get EXISTING_PLAN pricing, whatever the setting. Important Notes: - One-time and free product lines can\u0026#x27;t be replaced. These lines carry the _appstle-one-time-product attribute, or _appstle-free-product set to true. Passing such a line\u0026#x27;s variant in oldVariants, or its ID as oldLineId, returns a 400. On the Admin API, remove a one-time line with oldOneTimeVariants instead - The replacement line gets a new id, so take line IDs from the latest response. An oldLineId that isn\u0026#x27;t on the contract returns a 400 - The merchant\u0026#x27;s minimum order value applies to both APIs. If the products\u0026#x27; total after the change would be below minOrderValue in the customer portal settings, the call returns a 400 with the error key minOrderValueNotMet - On the Admin API, a request whose oldVariants, newVariants, oldLineId, newOneTimeVariants and oldOneTimeVariants are all empty or missing changes nothing and returns a 200 with an empty body - On a prepaid subscription, the new line\u0026#x27;s price covers all the deliveries in one billing period - The shipping price is recalculated in the background after the change, unless the merchant turned off automatic shipping price calculation or set a custom delivery price on the subscription Storefront API calls: When a signed-in customer makes this call through the Storefront API, the merchant\u0026#x27;s customer portal settings apply. Merchants set them in the Appstle Subscriptions app under Customer Portal. Read them from Get customer portal settings and offer only the changes they allow. The call returns a 400 when: - Swapping is turned off: enableSwapProductFeature and enableSwapProductVariant are both false. The response has no errorKey, and its entityName is swapProductVariant. Offer swapping only when one of them is true - A quantity is below the minimum: a quantity in newVariants is lower than minQtyToAllowDuringAddProduct. The response has no errorKey - The subscription is locked until its minimum cycles: freezeOrderTillMinCycle is true, allowSwapWhenContractIsFreeze isn\u0026#x27;t true, and the subscription hasn\u0026#x27;t reached its minimum number of billing cycles. The message is the merchant\u0026#x27;s freezeUpdateSubscriptionMessage, and the error key is minCycleNotCompleteForUpdateSubscriptionContractDate - The subscription is prepaid with separate orders: allowEditQuantityPrepaidSeparatePlan is false. The error key is permissionDenied - A new variant isn\u0026#x27;t allowed: the variant is in disAllowVariantIdsForSubscriptionProductAdd; or allowProductIdsForSubscriptionProductAdd isn\u0026#x27;t empty and holds neither the variant nor its product; or productSelectionOption is PRODUCTS_FROM_ALL_PLANS or PRODUCTS_FROM_CURRENT_PLAN and neither the variant nor its product is in a subscription plan. The error key is productnotallowedforcustomerportal Admin API calls with an API key skip all of these checks. Storefront API calls ignore newOneTimeVariants, oldOneTimeVariants and stopSwapEmails: use the Subscription One-Time Products endpoints for one-time products. Use Cases: - Product upgrades/downgrades (e.g., switching coffee blend or size) - Quantity adjustments during product swap - Adding limited-time or seasonal products as one-time purchases (Admin API only) - Bulk product replacements for subscription migrations Authentication: Requires a signed-in customer. Call it through Shopify\u0026#x27;s App Proxy on the store\u0026#x27;s domain: the proxy signs the request and attaches the customer, so you send no API key.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Appstle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://appstleinc-aeca3e0a.mintlify.site/_mintlify/api/og/v2?division=Subscription+Management\u0026amp;title=Replace+product+variants+in+a+subscription+contract\u0026amp;description=Replaces+existing+product+variants+with+new+ones+in+a+subscription+contract%2C+so+you+can+swap+products+and+change+quantities.+On+the+Admin+API%2C+the+same+call+can\u0026amp;theme=5c3420c08540c444b143045f\u0026amp;signature=25a95fd2bfef5e26418672225ecdb4ecc9f13f47b5117b27ca0b911a1879da3b\">\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=\"Replace product variants in a subscription contract - Appstle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Replaces existing product variants with new ones in a subscription contract, so you can swap products and change quantities. On the Admin API, the same call can also add and remove one-time products. Key Features: - Bulk Replace: Replace multiple products at once by providing lists of old and new variants - Line-Specific Replace: Target a specific line item using oldLineId for precise replacement - Quantity Management: Set new quantities for replaced products - One-Time Products (Admin API only): Add or remove one-time purchase products with newOneTimeVariants and oldOneTimeVariants - Discounts: The store\u0026#x27;s customer portal setting decides the new products\u0026#x27; discount (see below) Discounts on the new products: The store\u0026#x27;s Discount policy for added products setting decides which discount the new products get, on both the Admin API and the Storefront API. The request body\u0026#x27;s carryForwardDiscount field is ignored. Merchants choose the policy in the Appstle Subscriptions app under Customer Portal: in Portal Editor → Settings → More rules → Discounts on added products, or, on stores without the Portal Editor, in Configuration → Order \u0026amp; Subscription Management. The default is the first option: - Use product\u0026#x27;s plan first, then current subscription discount (PRODUCT_THEN_EXISTING): a product in a plan with the same order frequency as this subscription gets that plan\u0026#x27;s discount. Other products, and products whose matching plan has no discount, get the subscription\u0026#x27;s current discount - Apply product\u0026#x27;s own subscription discount (PRODUCT_PLAN): a product in a plan with the same order frequency as this subscription gets that plan\u0026#x27;s discount. Other products get no discount - Apply current subscription discount (EXISTING_PLAN): the new products get the same discount as the subscription\u0026#x27;s existing items, including manual price adjustments - No discount on added products (NONE): the new products are charged at their regular price On a prepaid subscription that ships as separate orders, the new products always get EXISTING_PLAN pricing, whatever the setting. Important Notes: - One-time and free product lines can\u0026#x27;t be replaced. These lines carry the _appstle-one-time-product attribute, or _appstle-free-product set to true. Passing such a line\u0026#x27;s variant in oldVariants, or its ID as oldLineId, returns a 400. On the Admin API, remove a one-time line with oldOneTimeVariants instead - The replacement line gets a new id, so take line IDs from the latest response. An oldLineId that isn\u0026#x27;t on the contract returns a 400 - The merchant\u0026#x27;s minimum order value applies to both APIs. If the products\u0026#x27; total after the change would be below minOrderValue in the customer portal settings, the call returns a 400 with the error key minOrderValueNotMet - On the Admin API, a request whose oldVariants, newVariants, oldLineId, newOneTimeVariants and oldOneTimeVariants are all empty or missing changes nothing and returns a 200 with an empty body - On a prepaid subscription, the new line\u0026#x27;s price covers all the deliveries in one billing period - The shipping price is recalculated in the background after the change, unless the merchant turned off automatic shipping price calculation or set a custom delivery price on the subscription Storefront API calls: When a signed-in customer makes this call through the Storefront API, the merchant\u0026#x27;s customer portal settings apply. Merchants set them in the Appstle Subscriptions app under Customer Portal. Read them from Get customer portal settings and offer only the changes they allow. The call returns a 400 when: - Swapping is turned off: enableSwapProductFeature and enableSwapProductVariant are both false. The response has no errorKey, and its entityName is swapProductVariant. Offer swapping only when one of them is true - A quantity is below the minimum: a quantity in newVariants is lower than minQtyToAllowDuringAddProduct. The response has no errorKey - The subscription is locked until its minimum cycles: freezeOrderTillMinCycle is true, allowSwapWhenContractIsFreeze isn\u0026#x27;t true, and the subscription hasn\u0026#x27;t reached its minimum number of billing cycles. The message is the merchant\u0026#x27;s freezeUpdateSubscriptionMessage, and the error key is minCycleNotCompleteForUpdateSubscriptionContractDate - The subscription is prepaid with separate orders: allowEditQuantityPrepaidSeparatePlan is false. The error key is permissionDenied - A new variant isn\u0026#x27;t allowed: the variant is in disAllowVariantIdsForSubscriptionProductAdd; or allowProductIdsForSubscriptionProductAdd isn\u0026#x27;t empty and holds neither the variant nor its product; or productSelectionOption is PRODUCTS_FROM_ALL_PLANS or PRODUCTS_FROM_CURRENT_PLAN and neither the variant nor its product is in a subscription plan. The error key is productnotallowedforcustomerportal Admin API calls with an API key skip all of these checks. Storefront API calls ignore newOneTimeVariants, oldOneTimeVariants and stopSwapEmails: use the Subscription One-Time Products endpoints for one-time products. Use Cases: - Product upgrades/downgrades (e.g., switching coffee blend or size) - Quantity adjustments during product swap - Adding limited-time or seasonal products as one-time purchases (Admin API only) - Bulk product replacements for subscription migrations Authentication: Requires a signed-in customer. Call it through Shopify\u0026#x27;s App Proxy on the store\u0026#x27;s domain: the proxy signs the request and attaches the customer, so you send no API key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://appstleinc-aeca3e0a.mintlify.site/_mintlify/api/og/v2?division=Subscription+Management\u0026amp;title=Replace+product+variants+in+a+subscription+contract\u0026amp;description=Replaces+existing+product+variants+with+new+ones+in+a+subscription+contract%2C+so+you+can+swap+products+and+change+quantities.+On+the+Admin+API%2C+the+same+call+can\u0026amp;theme=5c3420c08540c444b143045f\u0026amp;signature=25a95fd2bfef5e26418672225ecdb4ecc9f13f47b5117b27ca0b911a1879da3b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Appstle\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0caceb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.appstle.com/#organization\",\"name\":\"Appstle\",\"url\":\"https://developers.appstle.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://developers.appstle.com#website\",\"name\":\"Appstle\",\"url\":\"https://developers.appstle.com\",\"publisher\":{\"@id\":\"https://developers.appstle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract#webpage\",\"url\":\"https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract\",\"name\":\"Replace product variants in a subscription contract\",\"description\":\"Replaces existing product variants with new ones in a subscription contract, so you can swap products and change quantities. On the Admin API, the same call can also add and remove one-time products. Key Features: - Bulk Replace: Replace multiple products at once by providing lists of old and new variants - Line-Specific Replace: Target a specific line item using oldLineId for precise replacement - Quantity Management: Set new quantities for replaced products - One-Time Products (Admin API only): Add or remove one-time purchase products with newOneTimeVariants and oldOneTimeVariants - Discounts: The store's customer portal setting decides the new products' discount (see below) Discounts on the new products: The store's Discount policy for added products setting decides which discount the new products get, on both the Admin API and the Storefront API. The request body's carryForwardDiscount field is ignored. Merchants choose the policy in the Appstle Subscriptions app under Customer Portal: in Portal Editor → Settings → More rules → Discounts on added products, or, on stores without the Portal Editor, in Configuration → Order \u0026 Subscription Management. The default is the first option: - Use product's plan first, then current subscription discount (PRODUCT_THEN_EXISTING): a product in a plan with the same order frequency as this subscription gets that plan's discount. Other products, and products whose matching plan has no discount, get the subscription's current discount - Apply product's own subscription discount (PRODUCT_PLAN): a product in a plan with the same order frequency as this subscription gets that plan's discount. Other products get no discount - Apply current subscription discount (EXISTING_PLAN): the new products get the same discount as the subscription's existing items, including manual price adjustments - No discount on added products (NONE): the new products are charged at their regular price On a prepaid subscription that ships as separate orders, the new products always get EXISTING_PLAN pricing, whatever the setting. Important Notes: - One-time and free product lines can't be replaced. These lines carry the _appstle-one-time-product attribute, or _appstle-free-product set to true. Passing such a line's variant in oldVariants, or its ID as oldLineId, returns a 400. On the Admin API, remove a one-time line with oldOneTimeVariants instead - The replacement line gets a new id, so take line IDs from the latest response. An oldLineId that isn't on the contract returns a 400 - The merchant's minimum order value applies to both APIs. If the products' total after the change would be below minOrderValue in the customer portal settings, the call returns a 400 with the error key minOrderValueNotMet - On the Admin API, a request whose oldVariants, newVariants, oldLineId, newOneTimeVariants and oldOneTimeVariants are all empty or missing changes nothing and returns a 200 with an empty body - On a prepaid subscription, the new line's price covers all the deliveries in one billing period - The shipping price is recalculated in the background after the change, unless the merchant turned off automatic shipping price calculation or set a custom delivery price on the subscription Storefront API calls: When a signed-in customer makes this call through the Storefront API, the merchant's customer portal settings apply. Merchants set them in the Appstle Subscriptions app under Customer Portal. Read them from Get customer portal settings and offer only the changes they allow. The call returns a 400 when: - Swapping is turned off: enableSwapProductFeature and enableSwapProductVariant are both false. The response has no errorKey, and its entityName is swapProductVariant. Offer swapping only when one of them is true - A quantity is below the minimum: a quantity in newVariants is lower than minQtyToAllowDuringAddProduct. The response has no errorKey - The subscription is locked until its minimum cycles: freezeOrderTillMinCycle is true, allowSwapWhenContractIsFreeze isn't true, and the subscription hasn't reached its minimum number of billing cycles. The message is the merchant's freezeUpdateSubscriptionMessage, and the error key is minCycleNotCompleteForUpdateSubscriptionContractDate - The subscription is prepaid with separate orders: allowEditQuantityPrepaidSeparatePlan is false. The error key is permissionDenied - A new variant isn't allowed: the variant is in disAllowVariantIdsForSubscriptionProductAdd; or allowProductIdsForSubscriptionProductAdd isn't empty and holds neither the variant nor its product; or productSelectionOption is PRODUCTS_FROM_ALL_PLANS or PRODUCTS_FROM_CURRENT_PLAN and neither the variant nor its product is in a subscription plan. The error key is productnotallowedforcustomerportal Admin API calls with an API key skip all of these checks. Storefront API calls ignore newOneTimeVariants, oldOneTimeVariants and stopSwapEmails: use the Subscription One-Time Products endpoints for one-time products. Use Cases: - Product upgrades/downgrades (e.g., switching coffee blend or size) - Quantity adjustments during product swap - Adding limited-time or seasonal products as one-time purchases (Admin API only) - Bulk product replacements for subscription migrations Authentication: Requires a signed-in customer. Call it through Shopify's App Proxy on the store's domain: the proxy signs the request and attaches the customer, so you send no API key.\",\"dateModified\":\"2026-11-22T01:44:32.965Z\",\"isPartOf\":{\"@id\":\"https://developers.appstle.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Storefront API\",\"item\":\"https://developers.appstle.com/subscription-storefront-api/billing-\u0026-payments/get-backup-payment-recovery-opt-in-status\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Replace product variants in a subscription contract\",\"item\":\"https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract#apireference\",\"headline\":\"Replace product variants in a subscription contract\",\"name\":\"Replace product variants in a subscription contract\",\"description\":\"Replaces existing product variants with new ones in a subscription contract, so you can swap products and change quantities. On the Admin API, the same call can also add and remove one-time products. Key Features: - Bulk Replace: Replace multiple products at once by providing lists of old and new variants - Line-Specific Replace: Target a specific line item using oldLineId for precise replacement - Quantity Management: Set new quantities for replaced products - One-Time Products (Admin API only): Add or remove one-time purchase products with newOneTimeVariants and oldOneTimeVariants - Discounts: The store's customer portal setting decides the new products' discount (see below) Discounts on the new products: The store's Discount policy for added products setting decides which discount the new products get, on both the Admin API and the Storefront API. The request body's carryForwardDiscount field is ignored. Merchants choose the policy in the Appstle Subscriptions app under Customer Portal: in Portal Editor → Settings → More rules → Discounts on added products, or, on stores without the Portal Editor, in Configuration → Order \u0026 Subscription Management. The default is the first option: - Use product's plan first, then current subscription discount (PRODUCT_THEN_EXISTING): a product in a plan with the same order frequency as this subscription gets that plan's discount. Other products, and products whose matching plan has no discount, get the subscription's current discount - Apply product's own subscription discount (PRODUCT_PLAN): a product in a plan with the same order frequency as this subscription gets that plan's discount. Other products get no discount - Apply current subscription discount (EXISTING_PLAN): the new products get the same discount as the subscription's existing items, including manual price adjustments - No discount on added products (NONE): the new products are charged at their regular price On a prepaid subscription that ships as separate orders, the new products always get EXISTING_PLAN pricing, whatever the setting. Important Notes: - One-time and free product lines can't be replaced. These lines carry the _appstle-one-time-product attribute, or _appstle-free-product set to true. Passing such a line's variant in oldVariants, or its ID as oldLineId, returns a 400. On the Admin API, remove a one-time line with oldOneTimeVariants instead - The replacement line gets a new id, so take line IDs from the latest response. An oldLineId that isn't on the contract returns a 400 - The merchant's minimum order value applies to both APIs. If the products' total after the change would be below minOrderValue in the customer portal settings, the call returns a 400 with the error key minOrderValueNotMet - On the Admin API, a request whose oldVariants, newVariants, oldLineId, newOneTimeVariants and oldOneTimeVariants are all empty or missing changes nothing and returns a 200 with an empty body - On a prepaid subscription, the new line's price covers all the deliveries in one billing period - The shipping price is recalculated in the background after the change, unless the merchant turned off automatic shipping price calculation or set a custom delivery price on the subscription Storefront API calls: When a signed-in customer makes this call through the Storefront API, the merchant's customer portal settings apply. Merchants set them in the Appstle Subscriptions app under Customer Portal. Read them from Get customer portal settings and offer only the changes they allow. The call returns a 400 when: - Swapping is turned off: enableSwapProductFeature and enableSwapProductVariant are both false. The response has no errorKey, and its entityName is swapProductVariant. Offer swapping only when one of them is true - A quantity is below the minimum: a quantity in newVariants is lower than minQtyToAllowDuringAddProduct. The response has no errorKey - The subscription is locked until its minimum cycles: freezeOrderTillMinCycle is true, allowSwapWhenContractIsFreeze isn't true, and the subscription hasn't reached its minimum number of billing cycles. The message is the merchant's freezeUpdateSubscriptionMessage, and the error key is minCycleNotCompleteForUpdateSubscriptionContractDate - The subscription is prepaid with separate orders: allowEditQuantityPrepaidSeparatePlan is false. The error key is permissionDenied - A new variant isn't allowed: the variant is in disAllowVariantIdsForSubscriptionProductAdd; or allowProductIdsForSubscriptionProductAdd isn't empty and holds neither the variant nor its product; or productSelectionOption is PRODUCTS_FROM_ALL_PLANS or PRODUCTS_FROM_CURRENT_PLAN and neither the variant nor its product is in a subscription plan. The error key is productnotallowedforcustomerportal Admin API calls with an API key skip all of these checks. Storefront API calls ignore newOneTimeVariants, oldOneTimeVariants and stopSwapEmails: use the Subscription One-Time Products endpoints for one-time products. Use Cases: - Product upgrades/downgrades (e.g., switching coffee blend or size) - Quantity adjustments during product swap - Adding limited-time or seasonal products as one-time purchases (Admin API only) - Bulk product replacements for subscription migrations Authentication: Requires a signed-in customer. Call it through Shopify's App Proxy on the store's domain: the proxy signs the request and attaches the customer, so you send no API key.\",\"url\":\"https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract\",\"mainEntityOfPage\":{\"@id\":\"https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract#webpage\"},\"dateModified\":\"2026-11-22T01:44:32.965Z\",\"publisher\":{\"@id\":\"https://developers.appstle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.appstle.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Appstle\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Appstle\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract.md","siteName":"Appstle","nav":{"global":null,"tabs":[{"tab":"Subscriptions","icon":"arrows-rotate","groups":[{"group":"Get started","pages":[{"title":"Appstle Subscriptions: Recurring Revenue for Shopify","sidebarTitle":"Introduction","href":"/subscription/introduction"},{"title":"Authenticate with the Appstle Subscriptions API","sidebarTitle":"Authentication","href":"/subscription/authentication"},{"title":"Get started with Appstle Subscriptions API","sidebarTitle":"Quickstart","href":"/subscription/quickstart"}]},{"group":"Backend integration","pages":[{"title":"Appstle Subscriptions integration guide","sidebarTitle":"Integration guide","href":"/subscription/integration-guide"},{"title":"Appstle Subscriptions webhook events and setup","sidebarTitle":"Webhooks","href":"/subscription/webhooks"},{"title":"Automate subscriptions with Shopify Flow","sidebarTitle":"Shopify Flow","href":"/subscription/shopify-flow"},{"title":"Klaviyo events reference","sidebarTitle":"Klaviyo events","href":"/subscription/klaviyo-events"}]},{"group":"Storefront integration","pages":[{"title":"Build your own subscription frontend","sidebarTitle":"Build your own frontend","href":"/subscription/build-your-own-frontend"},{"title":"Build a Dynamic Pricing Build-a-Box with a custom UI","sidebarTitle":"Dynamic Pricing Build-a-Box","href":"/subscription/dynamic-pricing-box-custom-ui"},{"title":"Build a fixed-price Build-a-Box with a custom UI","sidebarTitle":"Fixed-price Build-a-Box","href":"/subscription/fixed-price-box-custom-ui"},{"title":"Sell gift subscriptions from your own storefront","sidebarTitle":"Gift subscriptions","href":"/subscription/gift-subscriptions"},{"title":"JavaScript events for the Appstle storefront widget","sidebarTitle":"JavaScript hooks","href":"/subscription/javascript-hooks"},{"title":"Shopify metafields and tags for Appstle Subscriptions","sidebarTitle":"Metafields \u0026 tags","href":"/subscription/metafields-and-tags"}]},{"group":"Partner integration","pages":[{"title":"Partner Integration Framework overview","sidebarTitle":"Framework overview","href":"/subscription/partner-framework-overview"},{"title":"Partner Integration Framework","sidebarTitle":"Partner integration","href":"/subscription/partner-integration"}]},{"group":"Resources","pages":[{"title":"Appstle Subscriptions API changelog","sidebarTitle":"API changelog","href":"/subscription/api-changelog"},{"title":"Appstle Subscriptions frequently asked questions","sidebarTitle":"FAQ","href":"/subscription/faq"}]},{"group":"Admin API","pages":[{"group":"Operations \u0026 Settings","pages":[{"title":"Get/Search activity logs","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/activity-logs","href":"/subscription-admin-api/operations-\u0026-settings/getsearch-activity-logs"},{"title":"Bulk update subscription billing interval","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/bulk-automations/billing-interval","href":"/subscription-admin-api/operations-\u0026-settings/bulk-update-subscription-billing-interval"},{"title":"Bulk update subscription delivery method","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/bulk-automations/delivery-method","href":"/subscription-admin-api/operations-\u0026-settings/bulk-update-subscription-delivery-method"},{"title":"Bulk update subscription delivery price","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/bulk-automations/delivery-price","href":"/subscription-admin-api/operations-\u0026-settings/bulk-update-subscription-delivery-price"},{"title":"Hide subscriptions in bulk","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/bulk-automations/hide-subscriptions","href":"/subscription-admin-api/operations-\u0026-settings/hide-subscriptions-in-bulk"},{"title":"Replace products in subscriptions in bulk","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/bulk-automations/replace-product","href":"/subscription-admin-api/operations-\u0026-settings/replace-products-in-subscriptions-in-bulk"},{"title":"Get cancellation management configuration","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/cancellation-managements/{id}","href":"/subscription-admin-api/operations-\u0026-settings/get-cancellation-management-configuration"},{"title":"Create a new shipping/delivery profile","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/delivery-profiles/create-shipping-profile","href":"/subscription-admin-api/operations-\u0026-settings/create-a-new-shippingdelivery-profile"},{"title":"Create a new shipping/delivery profile (V2)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/delivery-profiles/v2/create-shipping-profile","href":"/subscription-admin-api/operations-\u0026-settings/create-a-new-shippingdelivery-profile-v2"},{"title":"Create a new shipping/delivery profile (V3)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/delivery-profiles/v3/create-shipping-profile","href":"/subscription-admin-api/operations-\u0026-settings/create-a-new-shippingdelivery-profile-v3"}]},{"group":"Subscription Contracts","pages":[{"title":"Associate external payment gateway customer with Shopify customer","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/associate-shopify-customer-to-external-payment-gateways","href":"/subscription-admin-api/subscription-contracts/associate-external-payment-gateway-customer-with-shopify-customer"},{"title":"Retrieve raw Shopify GraphQL response for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/contract-raw-response","href":"/subscription-admin-api/subscription-contracts/retrieve-raw-shopify-graphql-response-for-a-subscription-contract"},{"title":"Generate customer portal authentication token","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/customer-portal-token","href":"/subscription-admin-api/subscription-contracts/generate-customer-portal-authentication-token"},{"title":"Retrieve subscription contracts","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details","href":"/subscription-admin-api/subscription-contracts/retrieve-subscription-contracts"},{"title":"Add custom discount to subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-add-discount","href":"/subscription-admin-api/subscription-contracts/add-custom-discount-to-subscription"},{"title":"Apply discount code to subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-apply-discount","href":"/subscription-admin-api/subscription-contracts/apply-discount-code-to-subscription"},{"title":"Replace all line item attributes in bulk across subscription contracts","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-bulk-update-line-item-attributes","href":"/subscription-admin-api/subscription-contracts/replace-all-line-item-attributes-in-bulk-across-subscription-contracts"},{"title":"Send magic link email to customer for portal access","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contracts-email-magic-link","href":"/subscription-admin-api/subscription-contracts/send-magic-link-email-to-customer-for-portal-access"},{"title":"Remove discount from subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-remove-discount","href":"/subscription-admin-api/subscription-contracts/remove-discount-from-subscription"},{"title":"Update next billing date for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-billing-date","href":"/subscription-admin-api/subscription-contracts/update-next-billing-date-for-a-subscription-contract"},{"title":"Update billing interval for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-billing-interval","href":"/subscription-admin-api/subscription-contracts/update-billing-interval-for-a-subscription-contract"},{"title":"Update Subscription contract frequency by compatible selling-plan frequency","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-frequency-by-compatible-plan","href":"/subscription-admin-api/subscription-contracts/update-subscription-contract-frequency-by-compatible-selling-plan-frequency"},{"title":"Update Subscription contract frequency by selling plan","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-frequency-by-selling-plan","href":"/subscription-admin-api/subscription-contracts/update-subscription-contract-frequency-by-selling-plan"},{"title":"Update line item attributes for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-attributes","href":"/subscription-admin-api/subscription-contracts/update-line-item-attributes-for-a-subscription-contract"},{"title":"Update multiple line item attributes for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-multiple-line-item-attributes","href":"/subscription-admin-api/subscription-contracts/update-multiple-line-item-attributes-for-a-subscription-contract"},{"title":"Cancel a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json delete /api/external/v2/subscription-contracts/{id}","href":"/subscription-admin-api/subscription-contracts/cancel-a-subscription-contract"}]},{"group":"Build-a-Box \u0026 Bundles","pages":[{"title":"Update an existing Build-A-Box subscription bundle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/build-a-box","href":"/subscription-admin-api/build-a-box-\u0026-bundles/update-an-existing-build-a-box-subscription-bundle"},{"title":"Create a new Build-A-Box subscription bundle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/build-a-box","href":"/subscription-admin-api/build-a-box-\u0026-bundles/create-a-new-build-a-box-subscription-bundle"},{"title":"Retrieve Build-A-Box bundle details by handle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/build-a-box/{handle}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/retrieve-build-a-box-bundle-details-by-handle"},{"title":"Retrieve a Build-A-Box bundle by ID","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/build-a-box/{id}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/retrieve-a-build-a-box-bundle-by-id"},{"title":"Delete a Build-A-Box subscription bundle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json delete /api/external/v2/build-a-box/{id}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/delete-a-build-a-box-subscription-bundle"},{"title":"Get subscription bundle settings (Build-a-Box configuration)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-bundle-settings/{id}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/get-subscription-bundle-settings-build-a-box-configuration"},{"title":"Update subscription bundling configuration","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-bundling/update","href":"/subscription-admin-api/build-a-box-\u0026-bundles/update-subscription-bundling-configuration"},{"title":"Generate discount code for bundle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-bundlings/discount/{token}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/generate-discount-code-for-bundle"},{"title":"Get bundle details by handle","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-bundlings/external/get-bundle/{handle}","href":"/subscription-admin-api/build-a-box-\u0026-bundles/get-bundle-details-by-handle"}]},{"group":"Customization","pages":[{"title":"Get customer portal settings","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/customer-portal-settings/{id}","href":"/subscription-admin-api/customization/get-customer-portal-settings"},{"title":"Get custom CSS for customer portal","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-custom-csses/{id}","href":"/subscription-admin-api/customization/get-custom-css-for-customer-portal"},{"title":"Regenerate subscription widget scripts","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/theme-settings/regenerate-scripts-for-shop","href":"/subscription-admin-api/customization/regenerate-subscription-widget-scripts"}]},{"group":"Customer Retention","pages":[{"title":"Get customer retention activities","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/customer-retention-activities","href":"/subscription-admin-api/customer-retention/get-customer-retention-activities"}]},{"group":"Subscription Data","pages":[{"title":"Get delivery options for subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/data/contract-delivery-options","href":"/subscription-admin-api/subscription-data/get-delivery-options-for-subscription-contract"}]},{"group":"Customers","pages":[{"title":"Generate customer portal access link by customer ID or email","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/manage-subscription-link","href":"/subscription-admin-api/customers/generate-customer-portal-access-link-by-customer-id-or-email"},{"title":"Generate customer portal link","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/manage-subscription-link/{customerId}","href":"/subscription-admin-api/customers/generate-customer-portal-link"},{"title":"Retrieve customers with subscriptions","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/customers","href":"/subscription-admin-api/customers/retrieve-customers-with-subscriptions"},{"title":"Get customer payment methods from Shopify","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/shopify/customer/{customerId}/payment-methods","href":"/subscription-admin-api/customers/get-customer-payment-methods-from-shopify"},{"title":"Get detailed subscription information for a customer","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-customers-detail/valid/{customerId}","href":"/subscription-admin-api/customers/get-detailed-subscription-information-for-a-customer"},{"title":"Sync customer subscription details from Shopify","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-customers/sync-info/{customerId}","href":"/subscription-admin-api/customers/sync-customer-subscription-details-from-shopify"},{"title":"Get valid subscription contract IDs for a customer","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-customers/valid/{customerId}","href":"/subscription-admin-api/customers/get-valid-subscription-contract-ids-for-a-customer"},{"title":"Get customer details with subscriptions","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-customers/{id}","href":"/subscription-admin-api/customers/get-customer-details-with-subscriptions"}]},{"group":"Product Catalog","pages":[{"title":"Get all product swaps for a shop","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/product-swaps","href":"/subscription-admin-api/product-catalog/get-all-product-swaps-for-a-shop"},{"title":"Update an existing product swap automation","deprecated":true,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/product-swaps","href":"/subscription-admin-api/product-catalog/update-an-existing-product-swap-automation"},{"title":"Create a new product swap automation","deprecated":true,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/product-swaps","href":"/subscription-admin-api/product-catalog/create-a-new-product-swap-automation"},{"title":"Get product swap variant groups for a contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/product-swaps-by-variant-groups/{contractId}","href":"/subscription-admin-api/product-catalog/get-product-swap-variant-groups-for-a-contract"},{"title":"Get a specific product swap by ID","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/product-swaps/{id}","href":"/subscription-admin-api/product-catalog/get-a-specific-product-swap-by-id"},{"title":"Delete a product swap automation","deprecated":true,"version":null,"openapi":"/subscription/admin-api-swagger.json delete /api/external/v2/product-swaps/{id}","href":"/subscription-admin-api/product-catalog/delete-a-product-swap-automation"}]},{"group":"Subscription Management","pages":[{"title":"List quick checkout links","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/quick-checkout/links","href":"/subscription-admin-api/subscription-management/list-quick-checkout-links"},{"title":"Get subscription contract analytics and revenue metrics","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/analytics/{contractId}","href":"/subscription-admin-api/subscription-management/get-subscription-contract-analytics-and-revenue-metrics"},{"title":"Get available billing intervals for selling plan(s)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/billing-interval","href":"/subscription-admin-api/subscription-management/get-available-billing-intervals-for-selling-plans"},{"title":"Create a new subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-contract-details/create-subscription-contract","href":"/subscription-admin-api/subscription-management/create-a-new-subscription-contract"},{"title":"Get current billing cycle number for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/current-cycle/{contractId}","href":"/subscription-admin-api/subscription-management/get-current-billing-cycle-number-for-a-subscription-contract"},{"title":"Replace product variants in a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-contract-details/replace-variants-v3","href":"/subscription-admin-api/subscription-management/replace-product-variants-in-a-subscription-contract"},{"title":"Split or duplicate an existing subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-contract-details/split-existing-contract","href":"/subscription-admin-api/subscription-management/split-or-duplicate-an-existing-subscription-contract"},{"title":"Get subscription fulfillment details for latest order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/subscription-fulfillments/{contractId}","href":"/subscription-admin-api/subscription-management/get-subscription-fulfillment-details-for-latest-order"},{"title":"Sync the delivery price of a subscription contract from Shopify","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-sync-shipping-price","href":"/subscription-admin-api/subscription-management/sync-the-delivery-price-of-a-subscription-contract-from-shopify"},{"title":"Update delivery interval for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-delivery-interval","href":"/subscription-admin-api/subscription-management/update-delivery-interval-for-a-subscription-contract"},{"title":"Update subscription delivery method","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-delivery-method","href":"/subscription-admin-api/subscription-management/update-subscription-delivery-method"},{"title":"Update delivery price for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-delivery-price","href":"/subscription-admin-api/subscription-management/update-delivery-price-for-a-subscription-contract"},{"title":"Turn custom delivery price on or off for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-delivery-price-override","href":"/subscription-admin-api/subscription-management/turn-custom-delivery-price-on-or-off-for-a-subscription-contract"},{"title":"Update maximum cycles for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-max-cycles","href":"/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract"},{"title":"Update minimum cycles for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-min-cycles","href":"/subscription-admin-api/subscription-management/update-minimum-cycles-for-a-subscription-contract"},{"title":"Update order note for subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-order-note/{contractId}","href":"/subscription-admin-api/subscription-management/update-order-note-for-subscription"},{"title":"Update subscription delivery address and method","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-shipping-address","href":"/subscription-admin-api/subscription-management/update-subscription-delivery-address-and-method"},{"title":"Update subscription contract status","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-status","href":"/subscription-admin-api/subscription-management/update-subscription-contract-status"},{"title":"Get raw Shopify GraphQL contract response","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contracts/contract-external/{contractId}","href":"/subscription-admin-api/subscription-management/get-raw-shopify-graphql-contract-response"},{"title":"Update custom attributes on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/update-custom-note-attributes","href":"/subscription-admin-api/subscription-management/update-custom-attributes-on-a-subscription-contract"}]},{"group":"Billing \u0026 Payments","pages":[{"title":"Update subscription billing attempt","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts","href":"/subscription-admin-api/billing-\u0026-payments/update-subscription-billing-attempt"},{"title":"Update order note for a billing attempt","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts-update-order-note/{id}","href":"/subscription-admin-api/billing-\u0026-payments/update-order-note-for-a-billing-attempt"},{"title":"Trigger immediate billing for an order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/attempt-billing/{id}","href":"/subscription-admin-api/billing-\u0026-payments/trigger-immediate-billing-for-an-order"},{"title":"Get past orders","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-billing-attempts/past-orders","href":"/subscription-admin-api/billing-\u0026-payments/get-past-orders"},{"title":"Get past orders report with detailed filtering","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-billing-attempts/past-orders/report","href":"/subscription-admin-api/billing-\u0026-payments/get-past-orders-report-with-detailed-filtering"},{"title":"Reschedule a billing attempt to a new date","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/reschedule-order/{id}","href":"/subscription-admin-api/billing-\u0026-payments/reschedule-a-billing-attempt-to-a-new-date"},{"title":"Skip a specific order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/skip-order/{id}","href":"/subscription-admin-api/billing-\u0026-payments/skip-a-specific-order"},{"title":"Skip the next upcoming order for a subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/skip-upcoming-order","href":"/subscription-admin-api/billing-\u0026-payments/skip-the-next-upcoming-order-for-a-subscription"},{"title":"Get upcoming orders (top orders)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-billing-attempts/top-orders","href":"/subscription-admin-api/billing-\u0026-payments/get-upcoming-orders-top-orders"},{"title":"Unskip a previously skipped order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts/unskip-order/{id}","href":"/subscription-admin-api/billing-\u0026-payments/unskip-a-previously-skipped-order"}]},{"group":"Subscription Products","pages":[{"title":"Add product with custom price to subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contract-add-line-item","href":"/subscription-admin-api/subscription-products/add-product-with-custom-price-to-subscription"},{"title":"Add product to subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-add-line-item","href":"/subscription-admin-api/subscription-products/add-product-to-subscription"},{"title":"Add multiple products to subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-add-line-items","href":"/subscription-admin-api/subscription-products/add-multiple-products-to-subscription"},{"title":"Remove product from subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-remove-line-item","href":"/subscription-admin-api/subscription-products/remove-product-from-subscription"},{"title":"Remove multiple products from subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-remove-line-items","href":"/subscription-admin-api/subscription-products/remove-multiple-products-from-subscription"},{"title":"Update multiple properties of a subscription line item","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item","href":"/subscription-admin-api/subscription-products/update-multiple-properties-of-a-subscription-line-item"},{"title":"Update product line item price","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-price","href":"/subscription-admin-api/subscription-products/update-product-line-item-price"},{"title":"Update line item pricing policy with cycle-based discounts","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-pricing-policy","href":"/subscription-admin-api/subscription-products/update-line-item-pricing-policy-with-cycle-based-discounts"},{"title":"Update product line item quantity in subscription","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-quantity","href":"/subscription-admin-api/subscription-products/update-product-line-item-quantity-in-subscription"},{"title":"Update selling plan for a subscription line item","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-line-item-selling-plan","href":"/subscription-admin-api/subscription-products/update-selling-plan-for-a-subscription-line-item"}]},{"group":"Subscription One-Time Products","pages":[{"title":"Get all one-time products for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-one-offs-by-contractId","href":"/subscription-admin-api/subscription-one-time-products/get-all-one-time-products-for-a-subscription-contract"},{"title":"Add one-time product to subscription order","deprecated":true,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/subscription-admin-api/subscription-one-time-products/add-one-time-product-to-subscription-order"},{"title":"Remove one-time product from subscription order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json delete /api/external/v2/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/subscription-admin-api/subscription-one-time-products/remove-one-time-product-from-subscription-order"},{"title":"Get one-time products for next upcoming order","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/upcoming-subscription-contract-one-offs-by-contractId","href":"/subscription-admin-api/subscription-one-time-products/get-one-time-products-for-next-upcoming-order"}]},{"group":"Subscription Payments","pages":[{"title":"Update subscription payment method","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-existing-payment-method","href":"/subscription-admin-api/subscription-payments/update-subscription-payment-method"},{"title":"Send payment method update email to customer","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-payment-method","href":"/subscription-admin-api/subscription-payments/send-payment-method-update-email-to-customer"}]},{"group":"Subscription Plans","pages":[{"title":"Get all subscription groups","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-groups","href":"/subscription-admin-api/subscription-plans/get-all-subscription-groups"},{"title":"Update subscription group details and product assignments","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-groups","href":"/subscription-admin-api/subscription-plans/update-subscription-group-details-and-product-assignments"},{"title":"Create a new subscription group (selling plan group)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-groups","href":"/subscription-admin-api/subscription-plans/create-a-new-subscription-group-selling-plan-group"},{"title":"Get all selling plans across all subscription groups","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-groups/all-selling-plans","href":"/subscription-admin-api/subscription-plans/get-all-selling-plans-across-all-subscription-groups"},{"title":"Remove products or variants from ALL subscription groups","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-groups/remove-products","href":"/subscription-admin-api/subscription-plans/remove-products-or-variants-from-all-subscription-groups"},{"title":"Add products or variants to an existing subscription group (async)","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-groups/v3/{id}/add-products","href":"/subscription-admin-api/subscription-plans/add-products-or-variants-to-an-existing-subscription-group-async"},{"title":"Check status of an async add-products job","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-groups/v3/{id}/add-products/status","href":"/subscription-admin-api/subscription-plans/check-status-of-an-async-add-products-job"},{"title":"Get subscription group by ID","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json get /api/external/v2/subscription-groups/{id}","href":"/subscription-admin-api/subscription-plans/get-subscription-group-by-id"},{"title":"Add products or variants to an existing subscription group","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-groups/{id}/add-products","href":"/subscription-admin-api/subscription-plans/add-products-or-variants-to-an-existing-subscription-group"},{"title":"Bulk add products or variants to an existing subscription group","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json post /api/external/v2/subscription-groups/{id}/bulk-add-products","href":"/subscription-admin-api/subscription-plans/bulk-add-products-or-variants-to-an-existing-subscription-group"},{"title":"Remove products or variants from a subscription group","deprecated":null,"version":null,"openapi":"/subscription/admin-api-swagger.json put /api/external/v2/subscription-groups/{id}/remove-products","href":"/subscription-admin-api/subscription-plans/remove-products-or-variants-from-a-subscription-group"}]}]},{"group":"Storefront API","pages":[{"group":"Billing \u0026 Payments","pages":[{"title":"Get backup payment recovery opt-in status","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/backup-payment-opt-in","href":"/subscription-storefront-api/billing-\u0026-payments/get-backup-payment-recovery-opt-in-status"},{"title":"Update backup payment recovery opt-in status","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/backup-payment-opt-in","href":"/subscription-storefront-api/billing-\u0026-payments/update-backup-payment-recovery-opt-in-status"},{"title":"Update subscription billing attempt","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts","href":"/subscription-storefront-api/billing-\u0026-payments/update-subscription-billing-attempt"},{"title":"Trigger immediate billing for an order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/attempt-billing/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/trigger-immediate-billing-for-an-order"},{"title":"Get past orders","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-billing-attempts/past-orders","href":"/subscription-storefront-api/billing-\u0026-payments/get-past-orders"},{"title":"Get past orders report with detailed filtering","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-billing-attempts/past-orders/report","href":"/subscription-storefront-api/billing-\u0026-payments/get-past-orders-report-with-detailed-filtering"},{"title":"Reschedule a billing attempt to a new date","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/reschedule-order/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/reschedule-a-billing-attempt-to-a-new-date"},{"title":"Retry a failed billing attempt","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/retry-failed-billing-attempt","href":"/subscription-storefront-api/billing-\u0026-payments/retry-a-failed-billing-attempt"},{"title":"Get URL for 3DS / SCA security challenge","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-billing-attempts/security-challenge-action-url/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/get-url-for-3ds-sca-security-challenge"},{"title":"Skip a failed billing attempt's order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/skip-failed-order","href":"/subscription-storefront-api/billing-\u0026-payments/skip-a-failed-billing-attempts-order"},{"title":"Skip a specific order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/skip-order/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/skip-a-specific-order"},{"title":"Skip the next upcoming order for a subscription","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/skip-upcoming-order","href":"/subscription-storefront-api/billing-\u0026-payments/skip-the-next-upcoming-order-for-a-subscription"},{"title":"Get upcoming orders (top orders)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-billing-attempts/top-orders","href":"/subscription-storefront-api/billing-\u0026-payments/get-upcoming-orders-top-orders"},{"title":"Unskip a previously skipped order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-billing-attempts/unskip-order/{id}","href":"/subscription-storefront-api/billing-\u0026-payments/unskip-a-previously-skipped-order"},{"title":"Get subscription payment info for a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-payment-infos/{contractId}","href":"/subscription-storefront-api/billing-\u0026-payments/get-subscription-payment-info-for-a-contract"}]},{"group":"Product Catalog","pages":[{"title":"List discount rules applicable to bundles","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/bundle-discount-rules","href":"/subscription-storefront-api/product-catalog/list-discount-rules-applicable-to-bundles"},{"title":"Get variant data for a list of variant IDs","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/product-infos/variant-data/{variantIds}","href":"/subscription-storefront-api/product-catalog/get-variant-data-for-a-list-of-variant-ids"},{"title":"Get product swap variant groups for a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/product-swaps-by-variant-groups/{contractId}","href":"/subscription-storefront-api/product-catalog/get-product-swap-variant-groups-for-a-contract"},{"title":"Proxy a Shopify Storefront GraphQL request from the customer portal","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/storefront-graphql","href":"/subscription-storefront-api/product-catalog/proxy-a-shopify-storefront-graphql-request-from-the-customer-portal"}]},{"group":"Campaigns","pages":[{"title":"List applicable customer portal campaigns","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/campaigns/applicable","href":"/subscription-storefront-api/campaigns/list-applicable-customer-portal-campaigns"},{"title":"List applicable customer portal campaigns for multiple contracts in one call","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/campaigns/applicable-bulk","href":"/subscription-storefront-api/campaigns/list-applicable-customer-portal-campaigns-for-multiple-contracts-in-one-call"},{"title":"Get campaign landing details","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/campaigns/{id}/landing","href":"/subscription-storefront-api/campaigns/get-campaign-landing-details"},{"title":"Redeem a campaign offer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/campaigns/{id}/redeem","href":"/subscription-storefront-api/campaigns/redeem-a-campaign-offer"},{"title":"Track a campaign banner event","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/campaigns/{id}/track","href":"/subscription-storefront-api/campaigns/track-a-campaign-banner-event"}]},{"group":"cancellation-flow-customer-portal-resource","pages":[{"title":"Get subscriptionscpapicancellation flowspublished","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/cancellation-flows/published","href":"/subscription-storefront-api/cancellation-flow-customer-portal-resource/get-subscriptionscpapicancellation-flowspublished"}]},{"group":"Customer Retention","pages":[{"title":"Get cancellation management configuration","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/cancellation-managements/{id}","href":"/subscription-storefront-api/customer-retention/get-cancellation-management-configuration"},{"title":"Record a customer retention activity","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/customer-retention-activities","href":"/subscription-storefront-api/customer-retention/record-a-customer-retention-activity"},{"title":"Get subscriptionscpapicustomer retention activitieslatest discount usage","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-retention-activities/latest-discount-usage","href":"/subscription-storefront-api/customer-retention/get-subscriptionscpapicustomer-retention-activitieslatest-discount-usage"},{"title":"Get win-back offer landing details","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/win-back-campaigns/{id}/landing","href":"/subscription-storefront-api/customer-retention/get-win-back-offer-landing-details"},{"title":"Reactivate a subscription from a win-back offer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/win-back-campaigns/{id}/reactivate","href":"/subscription-storefront-api/customer-retention/reactivate-a-subscription-from-a-win-back-offer"}]},{"group":"Subscription Contracts","pages":[{"title":"Execute a configured cancellation retention offer and record the retention activity","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/cancellation-retention-offers/execute","href":"/subscription-storefront-api/subscription-contracts/execute-a-configured-cancellation-retention-offer-and-record-the-retention-activity"},{"title":"Get currently logged-in customer ID","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/logged-in-customer","href":"/subscription-storefront-api/subscription-contracts/get-currently-logged-in-customer-id"},{"title":"Skip or unskip a product line item for next order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/skip-unskip-subscription-contracts-product","href":"/subscription-storefront-api/subscription-contracts/skip-or-unskip-a-product-line-item-for-next-order"},{"title":"Update subscription contract details","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contract-details","href":"/subscription-storefront-api/subscription-contracts/update-subscription-contract-details"},{"title":"Get current billing cycle for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-details/current-cycle/{contractId}","href":"/subscription-storefront-api/subscription-contracts/get-current-billing-cycle-for-a-subscription-contract"},{"title":"Get order note for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-details/customer/{contractId}","href":"/subscription-storefront-api/subscription-contracts/get-order-note-for-a-subscription-contract"},{"title":"Merge an existing contract into another","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/merge-contract","href":"/subscription-storefront-api/subscription-contracts/merge-an-existing-contract-into-another"},{"title":"Replace contract variants in bulk (v2)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/replace-variants-v2","href":"/subscription-storefront-api/subscription-contracts/replace-contract-variants-in-bulk-v2"},{"title":"Get current customer's saved Shopify payment methods","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-details/shopify/customer/payment-methods","href":"/subscription-storefront-api/subscription-contracts/get-current-customers-saved-shopify-payment-methods"},{"title":"Reschedule a planned subscription fulfillment","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contract-details/subscription-fulfillment/reschedule","href":"/subscription-storefront-api/subscription-contracts/reschedule-a-planned-subscription-fulfillment"},{"title":"List Shopify fulfillments for a specific order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-details/subscription-fulfillments/order/{orderId}","href":"/subscription-storefront-api/subscription-contracts/list-shopify-fulfillments-for-a-specific-order"},{"title":"List Shopify fulfillments for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-details/subscription-fulfillments/{contractId}","href":"/subscription-storefront-api/subscription-contracts/list-shopify-fulfillments-for-a-subscription-contract"},{"title":"Swap a product within a Build-a-Box subscription","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contract-details/swap-bab-product","href":"/subscription-storefront-api/subscription-contracts/swap-a-product-within-a-build-a-box-subscription"},{"title":"Get subscription contract as a flattened map","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-raw/{contractId}","href":"/subscription-storefront-api/subscription-contracts/get-subscription-contract-as-a-flattened-map"},{"title":"Apply a discount code to a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-apply-discount","href":"/subscription-storefront-api/subscription-contracts/apply-a-discount-code-to-a-subscription-contract"},{"title":"Apply a cancellation-flow discount to a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-cancellation-discount","href":"/subscription-storefront-api/subscription-contracts/apply-a-cancellation-flow-discount-to-a-contract"},{"title":"Edit custom attributes on a single line item","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-edit-line-item-attributes","href":"/subscription-storefront-api/subscription-contracts/edit-custom-attributes-on-a-single-line-item"},{"title":"Email customer portal magic link to subscriber","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts-email-magic-link","href":"/subscription-storefront-api/subscription-contracts/email-customer-portal-magic-link-to-subscriber"},{"title":"Read freeze (skip-billing) status of a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts-freeze-status-detail","href":"/subscription-storefront-api/subscription-contracts/read-freeze-skip-billing-status-of-a-contract"},{"title":"Read freeze (skip-billing) status of a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-freeze-status-detail","href":"/subscription-storefront-api/subscription-contracts/read-freeze-skip-billing-status-of-a-contract-1"},{"title":"Check whether anchor day overwrite is enabled","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts-is-overwrite-anchor-day","href":"/subscription-storefront-api/subscription-contracts/check-whether-anchor-day-overwrite-is-enabled"},{"title":"Update product-level custom attributes on a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-product-custom-attributes","href":"/subscription-storefront-api/subscription-contracts/update-product-level-custom-attributes-on-a-contract"},{"title":"Remove a discount from a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-remove-discount","href":"/subscription-storefront-api/subscription-contracts/remove-a-discount-from-a-subscription-contract"},{"title":"Remove a line item from a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-remove-line-item","href":"/subscription-storefront-api/subscription-contracts/remove-a-line-item-from-a-subscription-contract"},{"title":"Update next billing date for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-billing-date","href":"/subscription-storefront-api/subscription-contracts/update-next-billing-date-for-a-subscription-contract"},{"title":"Update billing interval for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-billing-interval","href":"/subscription-storefront-api/subscription-contracts/update-billing-interval-for-a-subscription-contract"},{"title":"Update delivery method on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-delivery-method","href":"/subscription-storefront-api/subscription-contracts/update-delivery-method-on-a-subscription-contract"},{"title":"Set existing Shopify payment method on contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-existing-payment-method","href":"/subscription-storefront-api/subscription-contracts/set-existing-shopify-payment-method-on-contract"},{"title":"Change contract frequency by selecting a compatible selling-plan frequency","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-frequency-by-compatible-plan","href":"/subscription-storefront-api/subscription-contracts/change-contract-frequency-by-selecting-a-compatible-selling-plan-frequency"},{"title":"Change contract frequency by selecting a new selling plan","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-frequency-by-selling-plan","href":"/subscription-storefront-api/subscription-contracts/change-contract-frequency-by-selecting-a-new-selling-plan"},{"title":"Update custom attributes on contract line items","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-line-item-attributes","href":"/subscription-storefront-api/subscription-contracts/update-custom-attributes-on-contract-line-items"},{"title":"Update line item quantity on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-line-item-quantity","href":"/subscription-storefront-api/subscription-contracts/update-line-item-quantity-on-a-subscription-contract"},{"title":"Update order note on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-order-note/{contractId}","href":"/subscription-storefront-api/subscription-contracts/update-order-note-on-a-subscription-contract"},{"title":"Trigger payment method re-collection email","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-payment-method","href":"/subscription-storefront-api/subscription-contracts/trigger-payment-method-re-collection-email"},{"title":"Get raw Shopify subscription contracts for multiple contracts in one call","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts/contract-external-bulk","href":"/subscription-storefront-api/subscription-contracts/get-raw-shopify-subscription-contracts-for-multiple-contracts-in-one-call"},{"title":"Get raw Shopify subscription contract (external view)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts/contract-external/{contractId}","href":"/subscription-storefront-api/subscription-contracts/get-raw-shopify-subscription-contract-external-view"},{"title":"Get raw Shopify subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contracts/contract/{contractId}","href":"/subscription-storefront-api/subscription-contracts/get-raw-shopify-subscription-contract"},{"title":"Cancel and delete a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json delete /subscriptions/cp/api/subscription-contracts/{id}","href":"/subscription-storefront-api/subscription-contracts/cancel-and-delete-a-subscription-contract"},{"title":"Get current customer's subscription profile","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-customers","href":"/subscription-storefront-api/subscription-contracts/get-current-customers-subscription-profile"},{"title":"Get valid subscription contracts for a customer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-customers-detail/valid/{id}","href":"/subscription-storefront-api/subscription-contracts/get-valid-subscription-contracts-for-a-customer"},{"title":"List a customer's valid subscription contract IDs","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-customers/valid/{id}","href":"/subscription-storefront-api/subscription-contracts/list-a-customers-valid-subscription-contract-ids"},{"title":"Update line item quantities for a classic Build-a-Box subscription","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/update-classic-bab-subscription/{contractId}","href":"/subscription-storefront-api/subscription-contracts/update-line-item-quantities-for-a-classic-build-a-box-subscription"},{"title":"Update subscription contract order note","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/update-contract-order-note/{contractId}","href":"/subscription-storefront-api/subscription-contracts/update-subscription-contract-order-note"},{"title":"Add a fixed pricing bundle line item, with its child products, to a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/v2/subscription-contracts-add-bundle-line-item","href":"/subscription-storefront-api/subscription-contracts/add-a-fixed-pricing-bundle-line-item-with-its-child-products-to-a-subscription-contract"},{"title":"Add a line item to a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/v2/subscription-contracts-add-line-item","href":"/subscription-storefront-api/subscription-contracts/add-a-line-item-to-a-subscription-contract"},{"title":"Add a line item to a specific section of a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/v2/subscription-contracts-add-sectioned-line-item/{contractId}","href":"/subscription-storefront-api/subscription-contracts/add-a-line-item-to-a-specific-section-of-a-contract"}]},{"group":"Customer Portal","pages":[{"title":"Proxy GraphQL queries to Shopify Customer Account API","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/customer-account-api/graphql","href":"/subscription-storefront-api/customer-portal/proxy-graphql-queries-to-shopify-customer-account-api"},{"title":"Initiate Customer Account API OAuth flow","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/customer-account-api/initiate","href":"/subscription-storefront-api/customer-portal/initiate-customer-account-api-oauth-flow"},{"title":"Logout from Customer Account API","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-account-api/logout","href":"/subscription-storefront-api/customer-portal/logout-from-customer-account-api"},{"title":"Handle OAuth callback from Shopify","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-account-api/oauth/callback","href":"/subscription-storefront-api/customer-portal/handle-oauth-callback-from-shopify"},{"title":"Check Customer Account API authentication status","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-account-api/status","href":"/subscription-storefront-api/customer-portal/check-customer-account-api-authentication-status"},{"title":"Get shop info for the currently signed-in shop","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/shop-infos-by-current-login","href":"/subscription-storefront-api/customer-portal/get-shop-info-for-the-currently-signed-in-shop"}]},{"group":"Customization","pages":[{"title":"Get customer portal settings","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-portal-settings/{id}","href":"/subscription-storefront-api/customization/get-customer-portal-settings"},{"title":"Get customer portal label translations for locale","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/label-translations/locale","href":"/subscription-storefront-api/customization/get-customer-portal-label-translations-for-locale"},{"title":"Get shop customization CSS by category","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/shop-customizations/css/{category}","href":"/subscription-storefront-api/customization/get-shop-customization-css-by-category"},{"title":"Get custom CSS for customer portal","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-custom-csses/{id}","href":"/subscription-storefront-api/customization/get-custom-css-for-customer-portal"},{"title":"Get widget label translations for locale","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/widget-label-translations/locale","href":"/subscription-storefront-api/customization/get-widget-label-translations-for-locale"}]},{"group":"Subscription Data","pages":[{"title":"Get delivery options for subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/contract-delivery-options","href":"/subscription-storefront-api/subscription-data/get-delivery-options-for-subscription-contract"},{"title":"List live carrier-quoted shipping rates for a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/contract-live-shipping-rates","href":"/subscription-storefront-api/subscription-data/list-live-carrier-quoted-shipping-rates-for-a-subscription-contract"},{"title":"Get single product data by ID","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/product","href":"/subscription-storefront-api/subscription-data/get-single-product-data-by-id"},{"title":"List product handles for the shop","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/product-handles","href":"/subscription-storefront-api/subscription-data/list-product-handles-for-the-shop"},{"title":"Get products data with pagination","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/products","href":"/subscription-storefront-api/subscription-data/get-products-data-with-pagination"},{"title":"Get selling plans for products","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/products-selling-plans","href":"/subscription-storefront-api/subscription-data/get-selling-plans-for-products"},{"title":"Search subscription-enabled products with pagination","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/products1","href":"/subscription-storefront-api/subscription-data/search-subscription-enabled-products-with-pagination"},{"title":"List subscription products filtered by selling plans","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/selling-plan-products","href":"/subscription-storefront-api/subscription-data/list-subscription-products-filtered-by-selling-plans"},{"title":"List delivery options available for the shop","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/shop-delivery-options","href":"/subscription-storefront-api/subscription-data/list-delivery-options-available-for-the-shop"},{"title":"List subscription products available to the customer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/subscription-products","href":"/subscription-storefront-api/subscription-data/list-subscription-products-available-to-the-customer"},{"title":"Get compatible selling-plan frequencies","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/v2/compatible-selling-plan-frequencies","href":"/subscription-storefront-api/subscription-data/get-compatible-selling-plan-frequencies"},{"title":"Preview quantity changes for a compatible frequency change","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/v2/frequency-change-quantity-preview","href":"/subscription-storefront-api/subscription-data/preview-quantity-changes-for-a-compatible-frequency-change"},{"title":"List products with their selling plans (v2)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/v2/products-selling-plans","href":"/subscription-storefront-api/subscription-data/list-products-with-their-selling-plans-v2"},{"title":"Get variant contextual pricing","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/data/variant-contextual-pricing","href":"/subscription-storefront-api/subscription-data/get-variant-contextual-pricing"},{"title":"List saved addresses for the current customer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/v2/data/addresses","href":"/subscription-storefront-api/subscription-data/list-saved-addresses-for-the-current-customer"},{"title":"List supported shipping countries","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/v2/data/countries","href":"/subscription-storefront-api/subscription-data/list-supported-shipping-countries"},{"title":"List enabled presentment currencies for the shop","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/v2/data/currencies","href":"/subscription-storefront-api/subscription-data/list-enabled-presentment-currencies-for-the-shop"}]},{"group":"Delivery \u0026 Shipping","pages":[{"title":"List delivery profile locations","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/delivery-profiles/get-locations","href":"/subscription-storefront-api/delivery-\u0026-shipping/list-delivery-profile-locations"},{"title":"Get a page of order events (paginated)","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/orders/{orderId}/events","href":"/subscription-storefront-api/delivery-\u0026-shipping/get-a-page-of-order-events-paginated"},{"title":"Get the live fulfillment status for an order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/orders/{orderId}/live-status","href":"/subscription-storefront-api/delivery-\u0026-shipping/get-the-live-fulfillment-status-for-an-order"}]},{"group":"Loyalty Integration","pages":[{"title":"Get customer loyalty points and rewards data","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/loyalty-integration/customer","href":"/subscription-storefront-api/loyalty-integration/get-customer-loyalty-points-and-rewards-data"},{"title":"Get available ways to earn loyalty points","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/loyalty-integration/earn-options","href":"/subscription-storefront-api/loyalty-integration/get-available-ways-to-earn-loyalty-points"},{"title":"Redeem loyalty points for a reward","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/loyalty-integration/redeem","href":"/subscription-storefront-api/loyalty-integration/redeem-loyalty-points-for-a-reward"},{"title":"Get available loyalty point redemption options","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/loyalty-integration/redeem-options","href":"/subscription-storefront-api/loyalty-integration/get-available-loyalty-point-redemption-options"}]},{"group":"notification-resource","pages":[{"title":"Get subscriptionscpapinotification session","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/notification-session","href":"/subscription-storefront-api/notification-resource/get-subscriptionscpapinotification-session"}]},{"group":"Store Pickup","pages":[{"title":"List eligible pickup dates","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/pickup/eligible-dates","href":"/subscription-storefront-api/store-pickup/list-eligible-pickup-dates"},{"title":"Get the first eligible pickup date","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/pickup/eligible-dates/first","href":"/subscription-storefront-api/store-pickup/get-the-first-eligible-pickup-date"},{"title":"List eligible pickup times for a date","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/pickup/eligible-times","href":"/subscription-storefront-api/store-pickup/list-eligible-pickup-times-for-a-date"},{"title":"List eligible pickup times for a date","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/pickup/eligible-times","href":"/subscription-storefront-api/store-pickup/list-eligible-pickup-times-for-a-date-1"},{"title":"List available pickup locations","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/pickup/locations","href":"/subscription-storefront-api/store-pickup/list-available-pickup-locations"},{"title":"Update pickup and delivery details on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/pickup/subscription-selection","href":"/subscription-storefront-api/store-pickup/update-pickup-and-delivery-details-on-a-subscription-contract"}]},{"group":"Subscription Actions","pages":[{"title":"Execute a server-authoritative next-order delay","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-actions/reschedule-by-days/execute","href":"/subscription-storefront-api/subscription-actions/execute-a-server-authoritative-next-order-delay"},{"title":"Preview a server-authoritative next-order delay","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-actions/reschedule-by-days/preview","href":"/subscription-storefront-api/subscription-actions/preview-a-server-authoritative-next-order-delay"}]},{"group":"Build-a-Box \u0026 Bundles","pages":[{"title":"Get subscription bundle settings by ID","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-bundle-settings/{id}","href":"/subscription-storefront-api/build-a-box-\u0026-bundles/get-subscription-bundle-settings-by-id"},{"title":"Get a subscription bundling configuration by token","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-bundlings/by-token/{token}","href":"/subscription-storefront-api/build-a-box-\u0026-bundles/get-a-subscription-bundling-configuration-by-token"},{"title":"List single-product Build-a-Box bundlings for the shop","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-bundlings/single-product","href":"/subscription-storefront-api/build-a-box-\u0026-bundles/list-single-product-build-a-box-bundlings-for-the-shop"},{"title":"Get public Build-a-Box bundle details by handle (v3)","description":null,"deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/v3/subscription-bundlings/external/get-bundle/{handle}","href":"/subscription-storefront-api/build-a-box-\u0026-bundles/get-public-build-a-box-bundle-details-by-handle-v3"}]},{"group":"Subscription Management","pages":[{"title":"Replace product variants in a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/replace-variants-v3","href":"/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract"},{"title":"Split or duplicate an existing subscription contract","description":"Creates a new subscription contract by either splitting (moving) or duplicating selected line items from an existing contract. This endpoint allows you to divide a subscription into multiple contracts or create a copy with specific products.\n\n**Split vs Duplicate Mode:**\n- **Split (isSplitContract=true)**: Moves the selected line items from the original contract to a new contract. The original contract will no longer contain these items.\n- **Duplicate (isSplitContract=false)**: Creates a new contract with copies of the selected line items while keeping them in the original contract.\n\n**Important Notes:**\n- When splitting, at least one subscription product must remain in the original contract\n- The new contract inherits all settings from the original: customer, payment method, billing/delivery policies, shipping address, and custom attributes\n- Billing schedule is automatically generated for the new contract\n- One-time products and free products don't count towards the minimum product requirement\n\n**Use Cases:**\n- Split a subscription when customer wants different delivery schedules for different products\n- Create a gift subscription from an existing subscription\n- Separate products for different shipping addresses\n- Duplicate a subscription for testing or backup purposes\n\n**Authentication:** Requires a signed-in customer. Call it through Shopify's App Proxy on the store's domain: the proxy signs the request and attaches the customer, so you send no API key.","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/split-existing-contract","href":"/subscription-storefront-api/subscription-management/split-or-duplicate-an-existing-subscription-contract"},{"title":"Update subscription delivery address and method","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-shipping-address","href":"/subscription-storefront-api/subscription-management/update-subscription-delivery-address-and-method"},{"title":"Update subscription contract status","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contracts-update-status","href":"/subscription-storefront-api/subscription-management/update-subscription-contract-status"},{"title":"Update custom attributes on a subscription contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/update-custom-note-attributes","href":"/subscription-storefront-api/subscription-management/update-custom-attributes-on-a-subscription-contract"}]},{"group":"Subscription Contract Details","pages":[{"title":"Swap a product and change its delivery frequency in one change","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/swap-product-frequency","href":"/subscription-storefront-api/subscription-contract-details/swap-a-product-and-change-its-delivery-frequency-in-one-change"},{"title":"Preview a product swap with its delivery frequency and recurring price","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/swap-product-frequency/preview","href":"/subscription-storefront-api/subscription-contract-details/preview-a-product-swap-with-its-delivery-frequency-and-recurring-price"}]},{"group":"Subscription One-Time Products","pages":[{"title":"List one-time add-on products for a contract","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-contract-one-offs-by-contractId","href":"/subscription-storefront-api/subscription-one-time-products/list-one-time-add-on-products-for-a-contract"},{"title":"Save a one-time add-on for a billing attempt","deprecated":true,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/subscription-storefront-api/subscription-one-time-products/save-a-one-time-add-on-for-a-billing-attempt"},{"title":"Delete a one-time add-on from a billing attempt","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json delete /subscriptions/cp/api/subscription-contract-one-offs-by-contractId-and-billing-attempt-id","href":"/subscription-storefront-api/subscription-one-time-products/delete-a-one-time-add-on-from-a-billing-attempt"},{"title":"Update quantity of a one-time add-on","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json put /subscriptions/cp/api/subscription-contract-one-offs-update-quantity","href":"/subscription-storefront-api/subscription-one-time-products/update-quantity-of-a-one-time-add-on"},{"title":"Get one-time add-ons for the next upcoming order","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/upcoming-subscription-contract-one-offs-by-contractId","href":"/subscription-storefront-api/subscription-one-time-products/get-one-time-add-ons-for-the-next-upcoming-order"}]},{"group":"subscription-gift-resource","pages":[{"title":"Get subscriptionscpapisubscription gifts","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-gifts","href":"/subscription-storefront-api/subscription-gift-resource/get-subscriptionscpapisubscription-gifts"}]},{"group":"Subscription Plans","pages":[{"title":"List all selling plans available to the customer","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-groups/all-selling-plans","href":"/subscription-storefront-api/subscription-plans/list-all-selling-plans-available-to-the-customer"}]},{"group":"upcoming-order-reward-resource","pages":[{"title":"Get subscriptionscpapiupcoming order rewards","deprecated":null,"version":null,"openapi":"/subscription/storefront-api-swagger.json get /subscriptions/cp/api/upcoming-order-rewards","href":"/subscription-storefront-api/upcoming-order-reward-resource/get-subscriptionscpapiupcoming-order-rewards"}]}]}]},{"tab":"Loyalty","icon":"star","pages":[{"title":"Loyalty","href":"/loyalty/introduction"}]},{"tab":"Memberships","icon":"id-card","pages":[{"title":"Memberships","href":"/memberships/introduction"}]},{"tab":"Bundles","icon":"boxes-stacked","pages":[{"title":"Bundles","href":"/bundles/introduction"}]}]},"basePath":"","title":"Replace product variants in a subscription contract - Appstle","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}