Skip to main content

Update the maximum charge for a subscription

Update the maximum amount that merchants can be charged for their subscription. You should do this if you change your pricing model.

Note

If you try to create a usage record for a usage pricing plan with an amount that's less than the new usage record, then the request fails. You need to increase the cappedAmount, and then obtain merchant approval before you can create more usage records.

Anchor to RequirementsRequirements

Anchor to Step 1: Retrieve charge dataStep 1: Retrieve charge data

Make a request to the AppSubscription object for the following data:

  • id

  • cappedAmount

    The cappedAmount is the maximum that a merchant is billed for during the 30-day billing cycle. The currencyCode must be one of the supported currencies.

  • balanceUsed

    The following query is an example:

POST https://{shop}.myshopify.com/api/{api_version}/graphql.json

JSON response

{
"data": {
"node": {
"lineItems": [
{
"plan": {
"pricingDetails": {
"terms": "$1 for 100 emails",
"cappedAmount": {
"amount": "20.0",
"currencyCode": "USD"
},
"balanceUsed": {
"amount": "0.0",
"currencyCode": "USD"
}
}
}
}
]
}
},
...
}

Anchor to Step 2: Update the capped amountStep 2: Update the capped amount

Update the app subscription's capped amount by passing the AppSubscription ID to the appSubscriptionLineItemUpdate mutation as an argument.

The following mutation is an example:

POST https://{shop}.myshopify.com/api/{api_version}/graphql.json

JSON response

{
"data": {
"appSubscriptionLineItemUpdate": {
"userErrors": [],
"confirmationUrl": "https://domain.myshopify.com/admin/charges/4019585080/confirm_update_capped_amount?signature=BAh7BzoHaWRsKwc4AJbvOhJhdXRvX2FjdGl2YXRlRg%3D%3D--a93b35054feb213f04f1ee35ef5b569617ce6823",
"appSubscription": {
"id": "gid://shopify/AppSubscription/4019585080"
}
}
},
...
}

Anchor to Next stepsNext steps

Was this page helpful?