Create recurring charges based on usage

You want to add a usage-based billing model to your app. You want to combine the usage charges with a recurring subscription plan. You'd also like to create a usage record, and to listen for changes that the merchant might make to their usage limit.

In this tutorial, you'll learn how to do the following tasks:

• Create an app subscription

• Combine billing models in a pricing plan

• Create an app usage record

• Subscribe to webhooks to monitor app usage

• Create a Partner account

• Create a development store

• Create an app

When you use the appSubscriptionCreate mutation, you need to include the cappedAmount field, which indicates the maximum amount of usage the merchant is billed for within the Shopify 30-day billing cycle. You also need to include the terms field, which is reviewed by the merchant when they accept your pricing plan.

The AppSubscription.id and the AppSubscriptionLineItem.id that are included in the payload are then used to create app usage records.

To create an app subscription based on usage, use the appSubscriptionCreate mutation:

You can also create a recurring pricing plan and a usage pricing plan in a single mutation:

After you've created the usage pricing plan and the merchant has accepted the plan, you can create a usage record. The usage record needs to include the AppSubscriptionLineItem.id of the AppSubscription object that is returned by the appSubscriptionCreate mutation.

To create an app usage record, use the appUsageRecordCreate mutation:

Merchants can use the Shopify admin to change their capped amount. This is the maximum amount of usage to bill for within the Shopify 30-day billing cycle.

To receive notifications when merchants change the capped amount, subscribe to the GraphQL Admin API's APP_SUBSCRIPTIONS_UPDATE topic.

To receive a notification when merchants reach or exceed 90% of their capped amount, subscribe to the GraphQL Admin API's APP_SUBSCRIPTIONS_APPROACHING_CAPPED_AMOUNT topic.