• Requirements
  • Step 1: Retrieve charge data
  • Step 2: Update the capped amount
  • Next steps

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.

Requirements

Anchor link to section titled "Requirements"
  • Your app can make authenticated requests to the GraphQL Admin API.

Step 1: Retrieve charge data

Anchor link to section titled "Step 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:

Step 2: Update the capped amount

Anchor link to section titled "Step 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:

Next steps

Anchor link to section titled "Next steps"

Discounts

Learn about offering subscription discounts.

On this page

  • Requirements
  • Step 1: Retrieve charge data
  • Step 2: Update the capped amount
  • Next steps