Using the Marketplace API in your app

To help manage your app on Marketplace, use these Marketplace API endpoints.

A Marketplace app receives information about changes to a user's plan from the Marketplace purchase event webhook. A Marketplace purchase event is triggered when a user purchases, cancels, or changes their payment plan.

recommends testing your app with APIs and webhooks before submitting your listing to Marketplace so you can provide an ideal experience for customers. Before an onboarding expert approves your app, it must adequately handle the billing flows.

When a customer purchases a paid plan, free trial, or the free version of your Marketplace app, you'll receive the marketplace_purchase event webhook with the purchased action, which kicks off the purchasing flow.

Upgrading or downgrading a Marketplace app triggers the marketplace_purchase event webhook with the changed action, which kicks off the upgrade or downgrade flow.

Cancelling a Marketplace app triggers the marketplace_purchase event webhook with the cancelled action, which kicks off the cancellation flow.