Marketplace developers can grant app subscription discounts to attract and retain users. These can be managed, created, and deleted through both the Developer Center and the platform API.
Queries
- Returns an array containing metadata about a specific app discount
- Can only be queried directly at the root
- Only works for app collaborators
query {
marketplace_app_discounts (app_id: 123456) {
account_slug
discount
valid_until
}
}
import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });
const query = "query ($appId: ID!) { marketplace_app_discounts (app_id: $appId) { account_slug discount valid_until } }"
const variables = {
appId: 123456
};
Arguments
You can use the following argument(s) to reduce the number of results returned in your marketplace_app_discounts
query.
Argument | Description |
---|---|
app_id ID! | The app's unique identifier. |
Fields
You can use the following field(s) to specify what information your marketplace_app_discounts
query will return.
Field | Description | Enum values |
---|---|---|
account_id ID! | The account's unique identifier. | |
account_slug String! | The account's slug. | |
app_plan_ids [String!]! | The app plan IDs. | |
created_at String! | The discount's creation date. | |
discount Int! | The discount's percentage. | |
is_recurring Boolean! | Returns true if the discount is recurring. | |
period DiscountPeriod | The discount's period. If it returns null , the discount applies to both yearly and monthly plans. | MONTHLY YEARLY |
valid_until String! | The date the discount is valid until. |
Mutations
Grant a discount
The grant_marketplace_app_discount
mutation will grant a discount for a new marketplace app subscription. You can also specify what fields to query back when you run the mutation.
mutation {
grant_marketplace_app_discount (
account_slug: "Test",
app_id: 123456,
data: {
app_plan_ids: ["Basic"],
days_valid: 30,
discount: 10,
is_recurring: false,
period: MONTHLY
}) {
granted_discount {
app_id
period
discount
}
}
}
import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });
const query = "mutation ($slug: String!, $appId: ID!, $appPlanIds: [String!]!, $days: Int!, $discountPercent: Int!, $recurring: Boolean!, $period: DiscountPeriod) { grant_marketplace_app_discount ( account_slug: $slug, app_id: $appId, data: {app_plan_ids: $appPlanIds, days_valid: $days, discount: $discountPercent, is_recurring: $recurring, period: $period }) { granted_discount { app_id period discount } } }"
const variables = {
appId: 123456,
slug: "my-team-monday",
appPlanIds: ["Basic"],
days: 30,
discountPercent: 10,
recurring: false,
period: "MONTHLY"
};
const response = await mondayApiClient.request(query, variables);
Arguments
You can use the following argument(s) to specify which discount to grant.
Argument | Description | Supported fields |
---|---|---|
account_slug String! | The account's slug. | |
app_id ID! | The app's unique identifier. | |
data GrantMarketplaceAppDiscountData! | The discount's details. | app_plan_ids [String!]! days_valid Int! discount Int! is_recurring Boolean! period DiscountPeriod |
Delete a discount
The delete_marketplace_app_discount
mutation will delete an existing discount for a marketplace app subscription. You can specify what fields to query back when you run the mutation.
mutation {
delete_marketplace_app_discount (
account_slug: "Test",
app_id: 123456
) {
deleted_discount {
account_slug
app_id
}
}
}
import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });
const query =
"mutation ($slug: String!, $appId: ID!) { delete_marketplace_app_discount ( account_slug: $slug, app_id: $appId ) { deleted_discount { account_slug app_id } } }";
const variables = {
appId: 123456,
slug: "my-team-monday",
};
const response = await mondayApiClient.request(query, variables);
Arguments
You can use the following argument(s) to specify which discount to delete.
Argument | Description |
---|---|
account_slug String! | The account's slug. |
app_id ID! | The app's unique identifier. |