Share via

App monetization in tab

Browse code

Explore a sample Teams tab application that illustrates how to implement app monetization by opening a purchase dialog and initiating a purchase flow using the Teams JS SDK. This solution provides a clear example of integrating monetization capabilities directly into your Teams applications, enhancing user engagement and revenue opportunities.

Included Features

  • Tabs
  • App Monetization

Interaction with tab

tab-app-monetization

Try it yourself - experience the App in your Microsoft Teams client

Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.zip file link below) to your teams and/or as a personal app. (Uploading must be enabled for your tenant, see steps here).

App monetization in tab: Manifest

Prerequisites

Run the app (Using Microsoft 365 Agents Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Microsoft 365 Agents Toolkit for Visual Studio Code.

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Microsoft 365 Agents Toolkit extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  6. In the browser that launches, select the Add button to install the app to Teams.

1) Setup for App registration

  1. Register a new application in the Microsoft Entra ID – App Registrations portal.
  2. Select New Registration and on the register an application page, set following values:
    • Set name to your app name.
    • Choose the supported account types (any account type will work)
    • Leave Redirect URI empty.
    • Choose Register.
  3. On the overview page, copy and save the Application (client) ID. You’ll need this later when updating your Teams application manifest.

2) Setup for SAAS offer

  1. Register a SAAS offer in market place and generate an plan id for it Create SAAS Offer

3) Setup NGROK

  1. Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous

4) Setup for code

  1. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  2. Install node modules

    Inside node js folder, navigate to samples/tab-app-monetization/nodejs/ClientApp open your local terminal and run the below command to install node modules. You can do the same in Visual Studio code terminal by opening the project in Visual Studio code.

    npm install

    Note - Navigate to samples/tab-app-monetization/nodejs/ClientApp/src/components/tab.tsx and update the planId and term on line 14 and 15 with plan details created in step 2

  3. Run the solution from the same path terminal using below command.

    npm start

5) Setup Manifest for Teams

  1. Modify the manifest.json in the /appManifest folder and replace the following details

    • {{App-id}} with your application id created in step 1.
    • {{Domain-Name}} with your application's base url domain, e.g. For https://1234.ngrok-free.app the Domain Name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be 12345.devtunnels.ms.
    • {{Plan-id}} with plan id generated in step 2.

  2. Zip the contents of appManifest folder into a manifest.zip, and use the manifest.zip to deploy in app store or add to Teams.

  3. Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

    • Go to Microsoft Teams. From the lower left corner, select Apps
    • From the lower left corner, choose Apps -> Manage your apps -> Upload an app.
    • Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
    • Select Add in the pop-up dialog box. Your app is uploaded to Teams.

  4. Add the tab in personal scope.

6) Features of the sample

  • Add the tab in personal scope. app-install tab-page

  • On click of upgrade button will trigger the purchase flow. offer-region offer-popup offer-popup-checkout

Further reading