Create a usage-based subscription

• Your app can make authenticated requests to the GraphQL Admin API.

Make a request to the appSubscriptionCreate mutation with the following information:

• name
• returnURL

• terms

  Merchants review the terms of the subscription when they accept the pricing plan.

• 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.

The following mutation is an example:

Shopify uses the payload's AppSubscription.id and the AppSubscriptionLineItem.id to generate data for app usage records.

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

The following mutation is an example:

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

To receive a notification when merchants change the capped amount, subscribe to the GraphQL Admin API's APP_SUBSCRIPTIONS_UPDATE webhook 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 webhook topic.

To receive a notification when a subscription status changes, such as when a charge is successful, subscribe to the GraphQL Admin API's APP_SUBSCRIPTION_UPDATE webhook topic.