Monetization by monday relies on subscriptions that serve as a billing contract between a user and an app. Each subscription contains unique data about the user's billing frequency, plan type, and renewal period.

As a developer working with monday.com, it is important to familiarize yourself with the app_subscription API so you know how to access subscription details. This document will walk you through the available queries and mutations to read and modify the app_subscription object via the API.

Queries

Querying app_subscription will return the current app and account subscription details based on the token used. This method does not accept any arguments and returns an array.

You can only query app_subscription directly at the root, so it can't be nested within another query. Please note that you can only make this call within the context of an application, not from our API Playground. If an account has a mock subscription and a real one, it will only return the mock subscription.

query {
  app_subscription {
    billing_period
    days_left
    is_trial
    plan_id
    renewal_date
  }
}

let query = "query { app_subscription { billing_period days_left is_trial plan_id renewal_date } }";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

The example response body from the above query.

{ 
  "data": {
    "app_subscription":[
      {
        "billing_period": "monthly",
        "days_left": 278,
        "is_trial": true,
        "plan_id": "basic_plan_15_users",
        "renewal_date": "2023-08-27T00:00:00+00:00",
      }
    ]
  },
  "account_id": 5
}

Fields

You can use the following field(s) to specify what information your boards query will return.

Mutations

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, and 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.

mutation {
  set_mock_app_subscription (
       app_id:12345,
       partial_signing_secret: "abcde12345",
       is_trial: true,
       plan_id: "basic_plan_15_users"
  ) {
    plan_id
  }
}

Arguments

Remove mock app subscription

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

mutation {
 remove_mock_app_subscription (app_id:12345, partial_signing_secret:"abcde12345") {
   billing_period
   days_left
   is_trial
 }
}

Arguments

📘

Join our developer community!

We've created a community specifically for our devs where you can search through previous topics to find solutions, ask new questions, hear about new features and updates, and learn tips and tricks from other devs. Come join in on the fun! 😎