Are you sure you want to delete this access key?
title | intro | redirect_from | versions |
---|---|---|---|
Handling plan cancellations | 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. | [/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] | [{free-pro-team *}] |
For more information about cancelling as it relates to billing, see "Billing customers in {% data variables.product.prodname_marketplace %}."
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.
When a customer cancels a free or paid plan, your app must perform these steps to complete cancellation:
cancelled
event.{% note %}
Note: 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 "{% data variables.product.prodname_marketplace %} webhook events."
{% endnote %}
Press p or to see the previous file or, n or to see the next file
Are you sure you want to delete this access key?
Are you sure you want to delete this access key?
Are you sure you want to delete this access key?
Are you sure you want to delete this access key?