Implement entitlements API

Zoom APIs enable developers to request information from Zoom, including (but not limited) to user details and to perform actions on the Zoom developer platform on a user's behalf.

To get the app user's entitlement information for monetized apps, you must implement the Get app user entitlements API endpoint for your app.

Note

You only need to implement the entitlements scope for paid pricing plans. It is not required for free plans.

The endpoint provides the following entitlment information for your app user:

  • Entitlement ID.
  • Name of the pricing plan.
  • Pricing plan ID.

All API requests must be made over HTTPS and with the base URL: https://api.zoom.us/v2/. The complete URL varies depending on the accessed resource.

For example, to get app user entitlements in your app, you must make a GET request to the https://api.zoom.us/v2/marketplace/monetization/entitlements?user_id={userId} URL, where {userId} is the user's ID or email address.