Learn how to query app subscription data using the monday.com platform API

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.

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.

FieldsDescription
billing_period StringThe billing period frequency: monthly or yearly.
days_left IntThe number of days left until the subscription ends.
is_trial BooleanReturns true if it is still a trial subscription.
plan_id String!The subscription plan ID from the app's side.
pricing_version IntThe subscription's pricing version. Please note that this field is only available in API versions 2024-01 and later.
renewal_date Date!The date when the subscription renews.

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

ArgumentDescription
app_id ID!The app’s unique identifier. You can access this ID from the URL of your app in the following format: myaccount.monday.com/apps/manage/{YOUR_APP_ID}/app_versions/12345/sections/appDetails.
billing_period StringThe billing period frequency: monthly or yearly.
is_trial BooleanSpecifies whether or not the subscription is a trial. Defaults to false.
partial_signing_secret String!The last 10 characters of your app’s signing secret.
plan_id StringThe plan's unique identifier for the mock subscription.
pricing_version IntThe subscription's pricing version.
renewal_date DateThe date when the subscription renews. Defaults to one year in the future and follows UTC DateTime. Please note that the mutation will fail if you do not use a future date.

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

ArgumentDescription
app_id ID!The app's unique identifier. Please note that this argument's type is ID! in API versions 2023-10 and later.
partial_signing_secret String!The last 10 characters of your app's signing secret.

📘

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! 😎