Give a Customer a Discount on Their First Months (operator only)
li_set_team_discountOPERATOR ONLY. Reads, gives or ends a CUSTOMER's (team's) discount on a NEW subscription: the same discount the dashboard's Users & access page shows per team. Name the team ONE way: teamId, the email of anyone in it, or account (an account id, label, LinkedIn name or slug; refused when it matches accounts of two teams). Omit kind and end to read the discount running now (or null), with adminSentence saying what it does. Give one with kind: 'percent' (value 1-99), 'amount' (value = a fixed amount off each month in the team's billing currency, major units, e.g. 500 for ₹500) or 'free' (no value), for months first months (1-12, default 1). The team's next checkout charges those months up front at the discounted price, then the usual monthly price starts by itself, on Razorpay (INR) and PayPal (USD) alike. validUntil (a date, YYYY-MM-DD, good to the end of that day UTC; at most a year ahead) makes the offer expire: a checkout after it pays the usual price. note is internal (never shown to the customer). Giving one emails the customer a special offer with the price, the deadline and a Subscribe link, once; the reply's customerEmailed says whether it really went out ('emailed', or 'not emailed: '). Refused: a team that already pays monthly (a discount applies to a new subscription only), a free or complimentary team, and a team with a discount still running (end it first with end: true, which emails the customer that it ended). The automatic offer after a trial is set with li_set_trial_end_offer.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | true = end the running discount now (the next checkout pays the usual price) | |
| kind | No | 'percent', 'amount' (fixed off each month) or 'free'; omit to read | |
| note | No | Internal note, e.g. "asked on a call"; never shown to the customer | |
| No | The sign-in email of anyone in the team | ||
| value | No | Percent off (1-99), or the amount off each month in major units; not for free | |
| months | No | How many first months it covers, 1-12 (default 1) | |
| teamId | No | Team id (or use email or account) | |
| account | No | An account id, label, LinkedIn name or slug; its owner’s team is used | |
| validUntil | No | Offer valid until this day, YYYY-MM-DD (UTC); omit for no deadline |