The monday apps framework has three interfaces to manage your app’s monetization:

• **monday SDK:** Handles subscriptions in a frontend app

• **GraphQL API:** Allows your backend to access subscription information and create mock subscriptions for testing

• **Webhooks:** Sends subscription information to your backend and custom actions

## SDK methods

Frontend apps can use the following methods through the monday SDK.

### Open plan selection

This execute method opens the plan selection page or billing tab so users can upgrade or pay for your app. It only works for live apps currently in the marketplace and cannot be tested.

Users can update their subscription when the tab opens by subscribing, upgrading, downgrading, or canceling. For example, users may want to use a feature not available on their plan. You can show them the billing tab so they can upgrade to the next plan tier.

If the `isInPlanSelection` parameter is `true`, the plan selection page will open. You should use this when you want the user to pay for the app first.

If the `isInPlanSelection` parameter is `false`, the app's billing section will open instead.

**Code sample**

### Session token

Every time your app loads, we will generate a session token signed with your app’s client secret. You can get this token with the method `monday.get(‘sessionToken’)`. Your frontend should use this as the primary access to the current subscription.

You can find more information about this SDK method <a href="https://github.com/mondaycom/monday-sdk-js#mondaygettype-params--" target="_blank">here</a>.

**Code sample **

### App Context

Your app’s context contains helpful information to manage your app’s state, such as the board it’s connected to or the current user. Check out the <a href="https://developer.monday.com/apps/docs/mondayget#context-objects-that-return-for-board-views-item-views-and-dashboard-widgets" target="_blank">SDK</a> to see all of the context objects that you can return!

In the context payload, we will include the subscription information for the current account. You can access the context using the <a href="https://github.com/mondaycom/monday-sdk-js#mondaygettype-params--" target="_blank">`monday.get`</a> and <a href="https://github.com/mondaycom/monday-sdk-js#mondaylistentypeortypes-callback-params--" target="_blank">`monday.listen`</a> methods.

These methods are convenient, but you should always verify the subscription details in the session token since it is signed.

**Sample context object**

## GraphQL Methods

### App subscription

The `app_subscription` query returns the subscription object for the current app and account based on the token used. This method does not accept any arguments and returns an array.

If an account has a mock subscription and a real one, it will only return the mock subscription.

**Fields**

The following fields will determine the data returned from your `app_subscription` query.

**Sample query**

### Apps monetization status

The `apps_monetization`status\` query checks if an account supports monetization.

**Fields**

The following fields will determine the data returned from your `apps_monetization_status` query.

**Sample query**

### Set mock app subscription

The `set_mock_app_subscription` mutation will create a mock subscription for an account and app based on the token you're using. It returns an `app_subscription object`. Mock subscriptions disappear after 24 hours, and each account-app pair can create one mock subscription.

Please note that you may need to refresh your browser after creating a mock subscription so that it shows in your account.

The mutation takes an `app_id` argument, which you can get from the URL of your app. Follow these steps o find your `app_id`:

• Open the _Developers_ section.

• Click on your app.

• The URL of the page will follow this format: _myaccount.monday.com/apps/manage/{YOUR_APP_ID}/app_versions/12345/sections/appDetails_

**Arguments**

**Sample query**

### Remove mock app subscription

The `remove_mock_app_subscription` query removes the mock subscription for the current account. It will return an `app_subscription` object or an error if no mock subscription exists.

**Arguments**

## Webhooks

You can use the endpoint found in the **webhooks** section of your app's configuration screen to receive a notification when someone installs or uninstalls your app or creates, changes, renews, or cancels a subscription.

1. Install: The `install` webhook containing subscription data will be sent to the user once they install an app. The data may be for a trial subscription if a user installed an app for the first time that offers a trial plan. It can also be for a paid subscription if the user reinstalls an app that they previously paid for but then uninstalled.

2. Uninstall: The `uninstall` webhook containing subscription data will be sent to the app as soon as a user uninstalls an app.

3. Subscription created: The `app_subscription_created` webhook containing subscription data will be sent to the developer when a user purchases a plan.

4. Subscription changed: The `app_subscription_changed` webhook containing subscription data will be sent to the developer once a user upgrades or downgrades their subscription.

5. Subscription renewed: The `app_subscription_renewed` webhook containing the renewed subscription information will be sent to the developer when a user's subscription renews on the renewal date.

6. Subscription canceled by user: The `app_subscription_cancelled_by_user` webhook containing subscription data will be sent to the developer when a user cancels their subscription. Please note that the subscription will remain active until the paid period ends. Once the renewal date passes, their subscription will not renew and the developer will receive the `app_subscription_cancelled` webhook.

7. Subscription canceled: The `app_subscription_cancelled` webhook containing subscription data will be sent to the developer when the subscription actually ends due to a cancellation. When a user churns from monday.com, the webhook will contain a `reason` field indicating `monday_subscription_cancel_on_renewal`.

8. Undo subscription cancellation: The `app_subscription_cancellation_revoked_by_user` webhook containing subscription data will be sent to the developer when a user undoes their subscription cancellation before the renewal date. This event signifies that the subscription will automatically renew on the renewal date.

9. Trial subscription started: The `app_trial_subscription_started` webhook containing subscription data will be sent to the developer when a user starts a new app trial.

10. Trial subscription ended: The `app_trial_subscription_ended` webhook containing subscription data will be sent to the developer when a user ends an app trial.

We also expose subscription information in webhooks from monday to your app. In each case, the subscription is encoded in the _Authorization_ header of the request as a JWT. This JWT is signed with your app’s **client secret**.

If your app is listed in the marketplace and monetized through us, we will include the subscription information in three webhooks:

• Install webhook

• Custom action webhook

• Uninstall webhook

**Code sample**