content/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md

metadata

title: Handling plan cancellations
intro: >-
  Cancelling a {% data variables.product.prodname_marketplace %} app triggers
  the [`marketplace_purchase`
  event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events)
  webhook with the `cancelled` action, which kicks off the cancellation flow.
redirect_from:
  - >-
    /apps/marketplace/administering-listing-plans-and-user-accounts/cancelling-plans
  - >-
    /apps/marketplace/integrating-with-the-github-marketplace-api/cancelling-plans
  - /marketplace/integrating-with-the-github-marketplace-api/cancelling-plans
  - /developers/github-marketplace/handling-plan-cancellations
  - >-
    /developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations
  - >-
    /apps/publishing-apps-to-github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations
versions:
  fpt: '*'
  ghec: '*'
topics:
  - Marketplace
shortTitle: Plan cancellations

{% data reusables.marketplace.marketplace-apps-not-actions %}

For more information about cancelling as it relates to billing, see AUTOTITLE.

Step 1. Cancellation event

If a customer chooses to cancel a {% data variables.product.prodname_marketplace %} order, GitHub sends a marketplace_purchase webhook with the action cancelled to your app when the cancellation takes effect. If the customer cancels during a free trial, your app will receive the event immediately. When a customer cancels a paid plan, the cancellation will occur at the end of the customer's billing cycle.

Step 2. Deactivating customer accounts

When a customer cancels a free or paid plan, your app must perform these steps to complete cancellation:

1. Deactivate the account of the customer who canceled their plan.
2. Revoke the OAuth token your app received for the customer.
3. If your app is an {% data variables.product.prodname_oauth_app %}, remove all webhooks your app created for repositories.
4. Remove all customer data within 30 days of receiving the cancelled event.

We recommend using the marketplace_purchase webhook's effective_date to determine when a plan change will occur and periodically synchronizing the List accounts for a plan. For more information on webhooks, see AUTOTITLE.