subscriptionContractProductChange - admin-graphql - MUTATION

Version: 2024-10

Description:

Allows for the easy change of a Product in a Contract or a Product price change.

Access Scopes

`write_own_subscription_contracts` access scope. Also: The user must have manage_orders_information permission.

Arguments

• input: SubscriptionContractProductChangeInput! - The properties of the Product changes.
• lineId: ID! - The gid of the Subscription Line to update.
• subscriptionContractId: ID! - The ID of the subscription contract.

Returns

• contract: SubscriptionContract The new Subscription Contract object.
• lineUpdated: SubscriptionLine The updated Subscription Line.
• userErrors: SubscriptionDraftUserError! The list of errors that occurred from executing the mutation.

Examples

• Update both product and price in a subscription contract

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation($contractId: ID!, $lineId: ID!, $variantId: ID!) { subscriptionContractProductChange(subscriptionContractId: $contractId, lineId: $lineId, input: {productVariantId: $variantId, currentPrice: 500}) { contract { id updatedAt } lineUpdated { id currentPrice { amount } variantId } userErrors { field message code } } }\",\n \"variables\": {\n    \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n    \"lineId\": \"gid://shopify/SubscriptionLine/25476bfc-b794-4ff5-b41f-7a00eb252d55\",\n    \"variantId\": \"gid://shopify/ProductVariant/30322695\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation($contractId: ID!, $lineId: ID!, $variantId: ID!) {\n      subscriptionContractProductChange(subscriptionContractId: $contractId, lineId: $lineId, input: {productVariantId: $variantId, currentPrice: 500}) {\n        contract {\n          id\n          updatedAt\n        }\n        lineUpdated {\n          id\n          currentPrice {\n            amount\n          }\n          variantId\n        }\n        userErrors {\n          field\n          message\n          code\n        }\n      }\n    }`,\n    \"variables\": {\n      \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n      \"lineId\": \"gid://shopify/SubscriptionLine/25476bfc-b794-4ff5-b41f-7a00eb252d55\",\n      \"variantId\": \"gid://shopify/ProductVariant/30322695\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation($contractId: ID!, $lineId: ID!, $variantId: ID!) {\n    subscriptionContractProductChange(subscriptionContractId: $contractId, lineId: $lineId, input: {productVariantId: $variantId, currentPrice: 500}) {\n      contract {\n        id\n        updatedAt\n      }\n      lineUpdated {\n        id\n        currentPrice {\n          amount\n        }\n        variantId\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n  \"lineId\": \"gid://shopify/SubscriptionLine/25476bfc-b794-4ff5-b41f-7a00eb252d55\",\n  \"variantId\": \"gid://shopify/ProductVariant/30322695\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/SubscriptionContract/593791907\",\n  \"lineId\" => \"gid://shopify/SubscriptionLine/25476bfc-b794-4ff5-b41f-7a00eb252d55\",\n  \"variantId\" => \"gid://shopify/ProductVariant/30322695\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation($contractId: ID!, $lineId: ID!, $variantId: ID!) {\n    subscriptionContractProductChange(subscriptionContractId: $contractId, lineId: $lineId, input: {productVariantId: $variantId, currentPrice: 500}) {\n      contract {\n        id\n        updatedAt\n      }\n      lineUpdated {\n        id\n        currentPrice {\n          amount\n        }\n        variantId\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n      \"lineId\": \"gid://shopify/SubscriptionLine/25476bfc-b794-4ff5-b41f-7a00eb252d55\",\n      \"variantId\": \"gid://shopify/ProductVariant/30322695\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation($contractId: ID!, $lineId: ID!, $variantId: ID!) {\n  subscriptionContractProductChange(subscriptionContractId: $contractId, lineId: $lineId, input: {productVariantId: $variantId, currentPrice: 500}) {\n    contract {\n      id\n      updatedAt\n    }\n    lineUpdated {\n      id\n      currentPrice {\n        amount\n      }\n      variantId\n    }\n    userErrors {\n      field\n      message\n      code\n    }\n  }\n}"
        

  input: {
    "contractId": "gid://shopify/SubscriptionContract/593791907",
    "lineId": "gid://shopify/SubscriptionLine/25476bfc-b794-4ff5-b41f-7a00eb252d55",
    "variantId": "gid://shopify/ProductVariant/30322695"
  }

  response: {
    "data": {
      "subscriptionContractProductChange": {
        "contract": {
          "id": "gid://shopify/SubscriptionContract/593791907",
          "updatedAt": "2024-09-12T01:09:12Z"
        },
        "lineUpdated": {
          "id": "gid://shopify/SubscriptionLine/25476bfc-b794-4ff5-b41f-7a00eb252d55",
          "currentPrice": {
            "amount": "500.0"
          },
          "variantId": "gid://shopify/ProductVariant/30322695"
        },
        "userErrors": []
      }
    }
  }