Learn how to query an account's monday.com plan data using the platform API
monday.com offers a variety of plans for users to choose from based on their needs.
Plan queries
You can use the plan
query to retrieve an account's plan data via the API.
- Required scope:
account:read
- Returns an array containing metadata about a specific plan (returns
null
for users on trial accounts) - Can only be nested inside an
account
query
query {
account {
plan {
max_users
period
tier
version
}
}
}
let query = "query { account { plan { max_users period tier version } } }";
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)));
Fields
You can use the following fields to specify what information your plan
query will return.
Fields | Description |
---|---|
max_users Int! | The maximum number of users allowed on the plan. Returns 0 for free and developer accounts. Deprecated: use apps_monetization_info instead. |
period String | The plan's time period. |
tier String | The plan's tier. |
version Int! | The plan's version. |