appSubscriptionLineItemUpdate

mutation

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

Arguments

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

Was this section helpful?

Anchor to AppSubscriptionLineItemUpdatePayload returnsAppSubscriptionLineItemUpdatePayload returns

Anchor to appSubscriptionappSubscription • AppSubscription: The updated app subscription.
Anchor to confirmationUrlconfirmationUrl • URL: The URL where the merchant approves or declines the updated app subscription line item.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Updates the capped amount of a recurring application charge
appSubscriptionLineItemUpdate reference

Examples

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 {

}

}`,

{

variables: {

"id": "gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1",

"cappedAmount": {

"amount": 100.0,

"currencyCode": "USD"

}

);

const data = await response.json();

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-04/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();

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"
      }
    },
  },
});

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)

Input variables

JSON

{

"id": "gid://shopify/AppSubscriptionLineItem/1029266946?v=1&index=1",

"cappedAmount": {

"amount": 100,

"currencyCode": "USD"

}

Response

JSON

{

"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"

}