App billing process

1. A merchant starts an action that includes a charge, such as an app installation, a service plan upgrade, or an individual purchase.
2. Your app creates a charge for the merchant, using either the appPurchaseOneTimeCreate or the appSubscriptionCreate mutation.
3. Shopify verifies the charge and returns a confirmationUrl, which is a page that Shopify hosts for the merchant to approve charges.
4. The app should redirect the merchant to the confirmationUrl, where the merchant either approves or declines the charge.
5. If the merchant accepts the charge, then they're redirected to a returnUrl that your app specified when it issued the charge. If the charge is declined, then Shopify redirects the merchant to the Shopify admin, and provides a notification message about the app charge being declined.

The app billing process requires your app to perform actions that set up purchases.

A pricing model is how you monetize your app. Each pricing model configuration must contain an amount, a currencyCode, and an interval. You can also set the parameters that are allowed by the GraphQL Admin API's appSubscriptionCreate and appPurchaseOneTimeCreate mutations that are used for the charges.

Remix apps can set up plans by passing in the billing configuration when shopifyApp is called.

Learn more about pricing models.

Gating requests require merchants to pay for the app before they can access specific routes. To gate requests, you can verify whether there's an active payment and require one if there isn't. The following is an example for the process:

• Indicate which plans enable access to a specific route.

• Pass a check to determine if there's a purchase for any of the plans.

• Require a purchase if one isn't detected.

Remix apps can use the admin.billing.require function. The function verifies that there's an active payment and requires one if there isn't. You can send multiple plans to require. It passes if there's a purchase for any of the plans and returns information on the active purchase.

If your billing check doesn't find a purchase, then you can decide where to take the merchant. The following are examples:

• Request payment right away for one of the purchase configurations.

• Redirect the merchant to a page where they can select a plan.

  • In the plan selection page, you'll need to authenticate with the GraphQL Admin API for access. Remix apps can call authenticate.admin.

The GraphQL Admin API's webhookSubscriptionCreate mutation enables you to register webhooks for specific shop events.

In addition to the mandatory webhook topics, Shopify provides the following webhook topics for billing:

• APP_PURCHASES_ONE_TIME_UPDATE: Triggered when the status of an AppPurchaseOneTime object is changed.

• APP_SUBSCRIPTIONS_UPDATE: Triggered when the status, or capped amount, of an AppSubscription object is changed, and when a subscription's status changes.

• APP_SUBSCRIPTIONS_APPROACHING_CAPPED_AMOUNT: Triggered when the balance used on an app subscription crosses 90% of the capped amount.

The @shopify/shopify-app-remix package enables Remix apps to authenticate with Shopify and make calls to the GraphQL Admin API's billing resources.

Get started monetizing your app with a recurring or one-time charge pricing model.

Subscriptions

Use Shopify's billing resources to create subscription pricing models.

One-time app charge

Use Shopify's billing resources to create a one-time app charge pricing model.