Anchor to section titled 'undefined'app
app
mutation
Unstable
Updates the capped amount on the usage pricing plan of an app subscription line item.
Anchor to section titled 'Arguments'
Arguments
The new maximum amount of usage charges that can be incurred within a subscription billing interval.
The ID of the app subscription line item to be updated.
Was this section helpful?
Anchor to section titled 'AppSubscriptionLineItemUpdatePayload returns'
AppSubscriptionLineItemUpdatePayload returns
The updated app subscription.
The URL where the merchant approves or declines the updated app subscription line item.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: appSubscriptionLineItemUpdate
Query Reference for MUTATION: appSubscriptionLineItemUpdate
"mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {\n appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {\n appSubscription {\n # AppSubscription fields\n }\n confirmationUrl\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: appSubscriptionLineItemUpdate
"{\n \"cappedAmount\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: appSubscriptionLineItemUpdate
"input MoneyInput {\n amount: Decimal!\n currencyCode: CurrencyCode!\n}\n"Display Examples for MUTATION: appSubscriptionLineItemUpdate
[
{
"example": {
"type_name": "appsubscriptionlineitemupdate",
"title": "Update the capped amount on a subscription line item",
"description": "You can modify the capped amount on a usage pricing plan.",
"query_string": "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}",
"query_arguments": {
"cappedAmount": "$cappedAmount",
"id": "$id"
},
"variables": {
"id": "gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1",
"cappedAmount": {
"amount": 100,
"currencyCode": "USD"
}
},
"response": {
"data": {
"appSubscriptionLineItemUpdate": {
"userErrors": [],
"confirmationUrl": "https://billingshop.myshopify.com/admin/charges/193172482/1029266946/RecurringApplicationCharge/confirm_update_capped_amount?signature=BAh7BzoHaWRpBAJeWT06EmF1dG9fYWN0aXZhdGVG--e1967101cc0df9b5377c619e10f12d0ff036ff21",
"appSubscription": {
"id": "gid://shopify/AppSubscription/1029266946"
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/billing/test/unit/graph_api/admin/mutations/app_subscription_line_item_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the app subscription line item to be updated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "cappedAmount",
"description": "The new maximum amount of usage charges that can be incurred within a subscription billing interval.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "MoneyInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "cappedAmount",
"argValue": " {\"amount\":100,\"currencyCode\":\"USD\"}",
"typeKind": "MUTATION"
}
]
}
]