appSubscriptionLineItemUpdate - admin-graphql - MUTATION

Version: 2024-07

Description:

Updates the capped amount on the usage pricing plan of an app subscription line item.

Access Scopes

Arguments

• cappedAmount: MoneyInput! - The new maximum amount of usage charges that can be incurred within a subscription billing interval.
• id: ID! - The ID of the app subscription line item to be updated.

Returns

• appSubscription: AppSubscription The updated app subscription.
• confirmationUrl: URL The URL where the merchant approves or declines the updated app subscription line item.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Updates the capped amount of a recurring application charge

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) { appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) { userErrors { field message } confirmationUrl appSubscription { id } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1\",\n    \"cappedAmount\": {\n      \"amount\": 100.0,\n      \"currencyCode\": \"USD\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {\n      appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {\n        userErrors {\n          field\n          message\n        }\n        confirmationUrl\n        appSubscription {\n          id\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1\",\n      \"cappedAmount\": {\n        \"amount\": 100.0,\n        \"currencyCode\": \"USD\"\n      }\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 appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {\n    appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {\n      userErrors {\n        field\n        message\n      }\n      confirmationUrl\n      appSubscription {\n        id\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1\",\n  \"cappedAmount\": {\n    \"amount\": 100.0,\n    \"currencyCode\": \"USD\"\n  }\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 = <<<QUERY\n  mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {\n    appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {\n      userErrors {\n        field\n        message\n      }\n      confirmationUrl\n      appSubscription {\n        id\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1\",\n  \"cappedAmount\" => [\n    \"amount\" => 100.0,\n    \"currencyCode\" => \"USD\",\n  ],\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 appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {\n    appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {\n      userErrors {\n        field\n        message\n      }\n      confirmationUrl\n      appSubscription {\n        id\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1\",\n      \"cappedAmount\": {\n        \"amount\": 100.0,\n        \"currencyCode\": \"USD\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {\n  appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {\n    userErrors {\n      field\n      message\n    }\n    confirmationUrl\n    appSubscription {\n      id\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1",
    "cappedAmount": {
      "amount": 100.0,
      "currencyCode": "USD"
    }
  }

  response: {
    "data": {
      "appSubscriptionLineItemUpdate": {
        "userErrors": [],
        "confirmationUrl": "https://billingshop.myshopify.com/admin/charges/193172482/1029266946/RecurringApplicationCharge/confirm_update_capped_amount?signature=BAh7BzoHaWRpBAJeWT06EmF1dG9fYWN0aXZhdGVG--5d28879b4ac4355216b7e6d2f861f9c245272daa",
        "appSubscription": {
          "id": "gid://shopify/AppSubscription/1029266946"
        }
      }
    }
  }