@sense-apps/mantle 0.2.0 → 0.3.0

package/README.md

@@ -87,11 +87,21 @@ const maxBarViews = (subscription?.plan?.features["bar_views"]?.value as number)
 ```ts
 const plans = await client.getPlans();
 // Mantle Plan shape: id, name, total, subtotal, interval ("EVERY_30_DAYS" | "ANNUAL" | "QUARTERLY"),
-// trialDays, currencyCode, features, featuresOrder, flexBilling, …
+// trialDays, currencyCode, features, featuresOrder, discounts, autoAppliedDiscount, flexBilling, …
 ```
 
 Eligibility (tag rules, per-shop price/trial overrides) is resolved server-side — the list is exactly what this shop may buy, with override pricing already applied. Money fields (`total`, `subtotal`) are numbers only because that is Mantle's wire shape — treat them as display values.
 
+**Discounts** work like Mantle's: created in the Mantlekit dashboard as a percentage (`percentage: 20` = 20%) or fixed amount off, optionally limited to specific plans, for a number of billing intervals (or forever / until a date), and auto-applied to shops by tag. When one auto-applies, `plan.autoAppliedDiscount` is set and `plan.total` is already the discounted price, with `plan.subtotal` the original — render a slashed price:
+
+```ts
+if (plan.autoAppliedDiscount) {
+  render(`~~$${plan.subtotal}~~ $${plan.total}/mo — ${plan.autoAppliedDiscount.percentage}% off`);
+}
+```
+
+The same discount is forwarded to Shopify at subscribe time (on the recurring line item), so the approval screen and the real charge match what you displayed. Flex-billing plans never get auto-applied discounts (Shopify's discount input can't reach usage lines).
+
 ### 5. Subscribe / upgrade
 
 ```ts

package/dist/client.d.ts

@@ -59,6 +59,23 @@ export interface UsageCharge {
     terms: string;
     cappedAmount: number;
 }
+export interface Discount {
+    id: string;
+    name: string;
+    description: string | null;
+    /** Set for fixed-amount discounts. */
+    amount?: number;
+    amountCurrencyCode?: string;
+    presentmentAmount?: number;
+    presentmentCurrencyCode?: string;
+    /** Set for percentage discounts — human number, 20 = 20%. */
+    percentage?: number;
+    /** How many billing intervals the discount lasts; absent = forever. */
+    durationLimitInIntervals?: number;
+    /** The plan price after this discount. */
+    discountedAmount: number;
+    presentmentDiscountedAmount: number;
+}
 export interface Plan {
     id: string;
     name: string;
@@ -83,7 +100,14 @@ export interface Plan {
     usageCharges: UsageCharge[];
     usageChargeCappedAmount?: number;
     customFields: Record<string, unknown>;
-    discounts: never[];
+    /** Discounts attached to this plan (auto-apply and manual alike). */
+    discounts: Discount[];
+    /**
+     * The discount that auto-applies to this shop at subscribe time (targeted
+     * by plan/tags in the Mantlekit dashboard). `total` already reflects it;
+     * `subtotal` is the undiscounted price — render a slashed price when set.
+     */
+    autoAppliedDiscount?: Discount;
     flexBilling: boolean;
     flexBillingTerms: string | null;
     autoUpgradeToPlanId: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sense-apps/mantle",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Backend-only client for a self-hosted Mantlekit deployment — @heymantle/client-compatible shapes (Customer/Subscription/Plan/Feature) and API (identify, getPlans, getCustomer, subscribe) for Shopify apps.",
   "type": "module",
   "main": "dist/index.js",

package/src/client.ts

@@ -63,6 +63,24 @@ export interface UsageCharge {
   cappedAmount: number;
 }
 
+export interface Discount {
+  id: string;
+  name: string;
+  description: string | null;
+  /** Set for fixed-amount discounts. */
+  amount?: number;
+  amountCurrencyCode?: string;
+  presentmentAmount?: number;
+  presentmentCurrencyCode?: string;
+  /** Set for percentage discounts — human number, 20 = 20%. */
+  percentage?: number;
+  /** How many billing intervals the discount lasts; absent = forever. */
+  durationLimitInIntervals?: number;
+  /** The plan price after this discount. */
+  discountedAmount: number;
+  presentmentDiscountedAmount: number;
+}
+
 export interface Plan {
   id: string;
   name: string;
@@ -87,7 +105,14 @@ export interface Plan {
   usageCharges: UsageCharge[];
   usageChargeCappedAmount?: number;
   customFields: Record<string, unknown>;
-  discounts: never[];
+  /** Discounts attached to this plan (auto-apply and manual alike). */
+  discounts: Discount[];
+  /**
+   * The discount that auto-applies to this shop at subscribe time (targeted
+   * by plan/tags in the Mantlekit dashboard). `total` already reflects it;
+   * `subtotal` is the undiscounted price — render a slashed price when set.
+   */
+  autoAppliedDiscount?: Discount;
   flexBilling: boolean;
   flexBillingTerms: string | null;
   autoUpgradeToPlanId: string | null;