Anchor to section titled 'undefined'

appSubscriptionLineItemUpdate
mutation

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


The new maximum amount of usage charges that can be incurred within a subscription billing interval.

Anchor to id
id
required

The ID of the app subscription line item to be updated.


Was this section helpful?

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?

Examples

Hide code
DescriptionCopy
mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {
  appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {
    userErrors {
      field
      message
    }
    confirmationUrl
    appSubscription {
      id
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) { appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) { userErrors { field message } confirmationUrl appSubscription { id } } }",
 "variables": {
    "id": "gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1",
    "cappedAmount": {
      "amount": 100.0,
      "currencyCode": "USD"
    }
  }
}'
const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {
    appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {
      userErrors {
        field
        message
      }
      confirmationUrl
      appSubscription {
        id
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1",
      "cappedAmount": {
        "amount": 100.0,
        "currencyCode": "USD"
      }
    },
  },
);

const data = await response.json();
session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {
    appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {
      userErrors {
        field
        message
      }
      confirmationUrl
      appSubscription {
        id
      }
    }
  }
QUERY

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

response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {
      appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {
        userErrors {
          field
          message
        }
        confirmationUrl
        appSubscription {
          id
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1",
      "cappedAmount": {
        "amount": 100.0,
        "currencyCode": "USD"
      }
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {
    appSubscriptionLineItemUpdate(cappedAmount: $cappedAmount, id: $id) {
      userErrors {
        field
        message
      }
      confirmationUrl
      appSubscription {
        id
      }
    }
  }
QUERY;

$variables = [
  "id" => "gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1",
  "cappedAmount" => [
    "amount" => 100.0,
    "currencyCode" => "USD",
  ],
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "id": "gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1",
  "cappedAmount": {
    "amount": 100,
    "currencyCode": "USD"
  }
}
Hide code
Response
JSON
{
  "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"
    }
  }
}