App monetization utilizes subscriptions 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

• Returns an array containing the current app and account subscription details based on the token used
• Can only be queried directly at the root
• If an account has a mock subscription and a real one, it will only return the mock subscription

🚧

This query is called on the app-level. It can only be called within the context of an app, not from the API Playground.

It only returns details based on the token used. If you want to query all of your app's subscriptions, use the app_subscriptions object instead.

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": "yearly",
        "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 app_subscription 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