Skip to main content

Sunsetting your app

Removing an app can have serious implications for merchants who rely on its functionality. To ensure the best possible experience for merchants, follow this process when sunsetting your app. If you're a merchant looking to remove an app from your own store, then refer to the Shopify Help Center instead.

Note

The guidelines in this section apply to both full and limited visibility apps in the Shopify App Store.

Caution

Sunsetting is permanent. After you start sunsetting your app, you can't undo it, cancel it, or change its sunset date. To relist an app after it's been sunset, you must resubmit the app to the Shopify App Store.


Anchor to What happens when you sunset your appWhat happens when you sunset your app

When you start sunsetting your app in the Partner Dashboard, the following happens:

  • Shopify removes your app from the Shopify App Store right away. Merchants can no longer find or install it from the Shopify App Store.
  • Merchants who already have your app installed keep it until you complete the sunsetting process. Before you start, you need to email them about the sunset. Before your sunset date, you need to cancel their charges and uninstall your app from their stores.
  • You choose a sunset date at least 30 days from now. The 30-day window gives merchants proper notice so that they have time to find an alternative.

Anchor to Start sunsetting your appStart sunsetting your app

  1. Email the merchants in your app's current installs. Tell them that you're sunsetting the app, give them the sunset date, and suggest alternatives.
  2. In your Partner Dashboard, click Apps, click the name of the app that you want to sunset, and then click Distribution.
  3. In the Remove from App Store section, click Remove from App Store. Review what happens next in the Sunsetting your app dialog, and then click Continue.
  4. Choose a sunset date that's at least 30 days from now, and then click Continue.
  5. Type your app's name exactly as it's shown in the dialog, and then click Remove from App Store.

Shopify removes your app from the Shopify App Store right away. You don't need to wait for confirmation from Shopify before you continue with the sunsetting process.

After your app is removed, the Remove from App Store section shows your sunset date. To get a list of your current merchants, click Export merchant list. Shopify emails you the list as a CSV file.


Follow this timeline to ensure that your users have enough warning that you plan to sunset your app, giving them time to find alternative solutions.

  1. In addition to the email you sent before you started, send merchants at least one more reminder about the sunset before your sunset date.

  2. Cancel all app subscriptions for the stores that use your app with the GraphQL Admin API's appSubscriptionCancel mutation.

  3. Clean up any remaining installs by uninstalling your app from those stores with the GraphQL Admin API's appUninstall mutation. appUninstall takes no arguments and uninstalls only the calling app, so run it once for each store using that store's offline access token. Uninstalling removes your app without requiring the merchant to act, and triggers cleanup tasks in Shopify, including deleting any registered webhooks, script tags, and Shopify admin links. If your app is uninstalled during key rotation, then both the old and new access tokens become unusable. This is irreversible for a store, so uninstall only after you no longer need to make API calls for it.

  4. Remove your app from your servers.

    Caution

    You must complete steps 1 to 3 before removing your app from your servers. Cancelling subscriptions and uninstalling rely on your app's API access, and merchant communications need to reach users while the app still functions.


Anchor to Thirty days before you sunset the appThirty days before you sunset the app

  • Before you start sunsetting, send an email to your users that explains that you plan to sunset your app, provides the sunset date, and suggests that users uninstall the app from their store. If you're migrating users to a new Shopify app that you've developed, then include instructions on how to do so. Otherwise, instruct merchants to uninstall the app and find an alternative.

  • Start sunsetting your app in the Partner Dashboard. This removes your app from the Shopify App Store right away, so new merchants can't find or install it there during the sunsetting period.

  • Cancel any recurring app charges through the GraphQL Admin API (including active, frozen, or accepted charges).


Anchor to Two weeks before you sunset the appTwo weeks before you sunset the app

  • Post a notice in your app, notifying users that the app won't function after the sunset date.

  • Offer support to any users who need it during this period.


Anchor to One week before you sunset the appOne week before you sunset the app

  • Send an email reminding users of the sunset date. If merchants contact you for alternate apps to use, then direct them to the Shopify App Store.

  • Check whether any stores still have your app installed, and uninstall it from them as described in the sunsetting process.

  • Remove the app from your servers rather than deleting it from the Apps page in your Dev Dashboard.

    Caution

    Client IDs and historical app data aren't available if you delete the app from your Dev Dashboard. We recommend that you keep your app in the Dev Dashboard for this reason.

    Keeping your app in the Dev Dashboard retains historical app data, such as revenue, number of installs, and support interactions.


Was this page helpful?