@happyvertical/smrt-subscriptions 0.57.35 → 0.57.37

package/dist/manifest.json

@@ -2,7 +2,7 @@
   "version": "1.0.0",
   "timestamp": 0,
   "packageName": "@happyvertical/smrt-subscriptions",
-  "packageVersion": "0.57.35",
+  "packageVersion": "0.57.37",
   "objects": {
     "@happyvertical/smrt-subscriptions:SubscriptionPlanCollection": {
       "name": "subscriptionplancollection",
@@ -1115,22 +1115,38 @@
         "planKey": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "A short code that identifies the plan, such as starter or pro.",
+          "_meta": {
+            "description": "A short code that identifies the plan, such as starter or pro."
+          }
         },
         "name": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "What the plan is called, as customers see it.",
+          "_meta": {
+            "description": "What the plan is called, as customers see it."
+          }
         },
         "description": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "A sentence or two about what the plan offers.",
+          "_meta": {
+            "description": "A sentence or two about what the plan offers."
+          }
         },
         "status": {
           "type": "text",
           "required": false,
           "default": "active",
+          "description": "Whether the plan is a draft, on sale (active) or archived.",
+          "_meta": {
+            "description": "Whether the plan is a draft, on sale (active) or archived."
+          },
           "enum": [
             "active",
             "archived",
@@ -1140,22 +1156,38 @@
         "sortOrder": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "Where the plan sits when plans are listed; lower numbers come first.",
+          "_meta": {
+            "description": "Where the plan sits when plans are listed; lower numbers come first."
+          }
         },
         "priceAmount": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "What the plan costs each billing period, in cents, as a whole number.",
+          "_meta": {
+            "description": "What the plan costs each billing period, in cents, as a whole number."
+          }
         },
         "currency": {
           "type": "text",
           "required": false,
-          "default": "USD"
+          "default": "USD",
+          "description": "The currency the price is in, such as USD.",
+          "_meta": {
+            "description": "The currency the price is in, such as USD."
+          }
         },
         "billingInterval": {
           "type": "text",
           "required": false,
           "default": "month",
+          "description": "How often the subscriber is billed: every day, week, month or year.",
+          "_meta": {
+            "description": "How often the subscriber is billed: every day, week, month or year."
+          },
           "enum": [
             "day",
             "week",
@@ -1167,6 +1199,10 @@
           "type": "text",
           "required": false,
           "default": "fixed",
+          "description": "Whether the plan is free, has a fixed price, or lets the subscriber choose what to pay. It cannot change once the plan is saved.",
+          "_meta": {
+            "description": "Whether the plan is free, has a fixed price, or lets the subscriber choose what to pay. It cannot change once the plan is saved."
+          },
           "enum": [
             "free",
             "fixed",
@@ -1176,12 +1212,20 @@
         "minimumAmount": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "For a pay-what-you-can plan, the least a subscriber may pay, in cents.",
+          "_meta": {
+            "description": "For a pay-what-you-can plan, the least a subscriber may pay, in cents."
+          }
         },
         "suggestedAmount": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "For a pay-what-you-can plan, the amount suggested to the subscriber, in cents.",
+          "_meta": {
+            "description": "For a pay-what-you-can plan, the amount suggested to the subscriber, in cents."
+          }
         },
         "externalProvider": {
           "type": "text",
@@ -1591,31 +1635,55 @@
         "planId": {
           "type": "foreignKey",
           "required": false,
-          "related": "SubscriptionPlan"
+          "related": "SubscriptionPlan",
+          "description": "The plan this version belongs to.",
+          "_meta": {
+            "description": "The plan this version belongs to."
+          }
         },
         "planKey": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "The plan code at the time this version was published.",
+          "_meta": {
+            "description": "The plan code at the time this version was published."
+          }
         },
         "version": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "Which version of the plan this is, counting from 1.",
+          "_meta": {
+            "description": "Which version of the plan this is, counting from 1."
+          }
         },
         "effectiveFrom": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "The date and time from which these terms apply.",
+          "_meta": {
+            "description": "The date and time from which these terms apply."
+          }
         },
         "name": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "What the plan was called when this version was published.",
+          "_meta": {
+            "description": "What the plan was called when this version was published."
+          }
         },
         "status": {
           "type": "text",
           "required": false,
           "default": "active",
+          "description": "Whether the plan was a draft, on sale (active) or archived under this version.",
+          "_meta": {
+            "description": "Whether the plan was a draft, on sale (active) or archived under this version."
+          },
           "enum": [
             "active",
             "archived",
@@ -1625,17 +1693,29 @@
         "priceAmount": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "What the plan cost each billing period under this version, in cents.",
+          "_meta": {
+            "description": "What the plan cost each billing period under this version, in cents."
+          }
         },
         "currency": {
           "type": "text",
           "required": false,
-          "default": "USD"
+          "default": "USD",
+          "description": "The currency the price is in, such as USD.",
+          "_meta": {
+            "description": "The currency the price is in, such as USD."
+          }
         },
         "billingInterval": {
           "type": "text",
           "required": false,
           "default": "month",
+          "description": "How often the subscriber was billed: every day, week, month or year.",
+          "_meta": {
+            "description": "How often the subscriber was billed: every day, week, month or year."
+          },
           "enum": [
             "day",
             "week",
@@ -1647,6 +1727,10 @@
           "type": "text",
           "required": false,
           "default": "fixed",
+          "description": "Whether the plan was free, had a fixed price, or let the subscriber choose what to pay.",
+          "_meta": {
+            "description": "Whether the plan was free, had a fixed price, or let the subscriber choose what to pay."
+          },
           "enum": [
             "free",
             "fixed",
@@ -1656,12 +1740,20 @@
         "minimumAmount": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "For a pay-what-you-can plan, the least a subscriber could pay, in cents.",
+          "_meta": {
+            "description": "For a pay-what-you-can plan, the least a subscriber could pay, in cents."
+          }
         },
         "suggestedAmount": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "For a pay-what-you-can plan, the amount suggested to the subscriber, in cents.",
+          "_meta": {
+            "description": "For a pay-what-you-can plan, the amount suggested to the subscriber, in cents."
+          }
         },
         "features": {
           "type": "text",
@@ -1934,6 +2026,10 @@
           "type": "text",
           "required": false,
           "default": "tenant",
+          "description": "Whether the subscriber is your own workspace (tenant) or an outside customer (external).",
+          "_meta": {
+            "description": "Whether the subscriber is your own workspace (tenant) or an outside customer (external)."
+          },
           "enum": [
             "tenant",
             "external"
@@ -1942,17 +2038,29 @@
         "subscriberExternalId": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "Who the outside subscriber is, when the subscriber type is external.",
+          "_meta": {
+            "description": "Who the outside subscriber is, when the subscriber type is external."
+          }
         },
         "planId": {
           "type": "foreignKey",
           "required": false,
-          "related": "SubscriptionPlan"
+          "related": "SubscriptionPlan",
+          "description": "The plan this subscription is for.",
+          "_meta": {
+            "description": "The plan this subscription is for."
+          }
         },
         "status": {
           "type": "text",
           "required": false,
           "default": "incomplete",
+          "description": "Where the subscription stands: incomplete, trialing, active, past due, unpaid or cancelled.",
+          "_meta": {
+            "description": "Where the subscription stands: incomplete, trialing, active, past due, unpaid or cancelled."
+          },
           "enum": [
             "active",
             "canceled",
@@ -1964,37 +2072,69 @@
         },
         "startedAt": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "The day the subscription began.",
+          "_meta": {
+            "description": "The day the subscription began."
+          }
         },
         "currentPeriodStart": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "When the current billing period began.",
+          "_meta": {
+            "description": "When the current billing period began."
+          }
         },
         "currentPeriodEnd": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "When the current billing period ends and the next one is due.",
+          "_meta": {
+            "description": "When the current billing period ends and the next one is due."
+          }
         },
         "trialEndsAt": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "When the free trial ends, if there is one.",
+          "_meta": {
+            "description": "When the free trial ends, if there is one."
+          }
         },
         "cancelAtPeriodEnd": {
           "type": "boolean",
           "required": false,
-          "default": false
+          "default": false,
+          "description": "Tick to let the subscription run out at the end of the current period instead of renewing.",
+          "_meta": {
+            "description": "Tick to let the subscription run out at the end of the current period instead of renewing."
+          }
         },
         "canceledAt": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "When the subscription was cancelled.",
+          "_meta": {
+            "description": "When the subscription was cancelled."
+          }
         },
         "agreedAmount": {
           "type": "integer",
-          "required": false
+          "required": false,
+          "description": "For a pay-what-you-can plan, the amount the subscriber chose to pay, in cents.",
+          "_meta": {
+            "description": "For a pay-what-you-can plan, the amount the subscriber chose to pay, in cents."
+          }
         },
         "planVersionId": {
           "type": "foreignKey",
           "required": false,
-          "related": "SubscriptionPlanVersion"
+          "related": "SubscriptionPlanVersion",
+          "description": "The version of the plan terms this subscription is held to for the current period. It is kept up to date automatically.",
+          "_meta": {
+            "description": "The version of the plan terms this subscription is held to for the current period. It is kept up to date automatically."
+          }
         },
         "planVersionPinnedAt": {
           "type": "datetime",
@@ -2967,32 +3107,56 @@
         "provider": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "Who supplied the service that was used.",
+          "_meta": {
+            "description": "Who supplied the service that was used."
+          }
         },
         "serviceKey": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "The service that was used.",
+          "_meta": {
+            "description": "The service that was used."
+          }
         },
         "metricKey": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "What was used, such as messages sent or minutes of audio.",
+          "_meta": {
+            "description": "What was used, such as messages sent or minutes of audio."
+          }
         },
         "quantity": {
           "type": "decimal",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "How much of it was used.",
+          "_meta": {
+            "description": "How much of it was used."
+          }
         },
         "amount": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "What it cost, in cents.",
+          "_meta": {
+            "description": "What it cost, in cents."
+          }
         },
         "currency": {
           "type": "text",
           "required": false,
-          "default": "USD"
+          "default": "USD",
+          "description": "The currency the amount is in, such as USD.",
+          "_meta": {
+            "description": "The currency the amount is in, such as USD."
+          }
         },
         "pricingRuleId": {
           "type": "foreignKey",
@@ -3013,6 +3177,10 @@
           "type": "text",
           "required": false,
           "default": "draft",
+          "description": "Where the charge stands: draft, approved or adjusted.",
+          "_meta": {
+            "description": "Where the charge stands: draft, approved or adjusted."
+          },
           "enum": [
             "draft",
             "approved",
@@ -3021,7 +3189,11 @@
         },
         "approvedAt": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "When the charge was approved.",
+          "_meta": {
+            "description": "When the charge was approved."
+          }
         }
       },
       "methods": {
@@ -6150,6 +6322,379 @@
     }
   },
   "moduleType": "smrt",
+  "recipes": [
+    {
+      "id": "subscriptions.plans",
+      "className": "SubscriptionPlansRecipe",
+      "label": "Subscriptions",
+      "summary": "Sell plans that renew, see who is subscribed to which, and what their usage cost.",
+      "synonyms": [
+        "subscriptions",
+        "subscription plans",
+        "plans",
+        "memberships",
+        "recurring billing",
+        "pricing tiers"
+      ],
+      "models": [
+        "@happyvertical/smrt-subscriptions:SubscriptionPlan",
+        "@happyvertical/smrt-subscriptions:SubscriptionPlanVersion",
+        "@happyvertical/smrt-subscriptions:TenantSubscription",
+        "@happyvertical/smrt-subscriptions:ClientCharge"
+      ],
+      "nav": [
+        {
+          "label": "Plans",
+          "model": "@happyvertical/smrt-subscriptions:SubscriptionPlan",
+          "icon": "tag",
+          "description": "The plans you sell, with their price and how often they bill.",
+          "noun": "plan"
+        },
+        {
+          "label": "Subscriptions",
+          "model": "@happyvertical/smrt-subscriptions:TenantSubscription",
+          "icon": "repeat",
+          "description": "Who is subscribed to which plan, and where each one stands.",
+          "noun": "subscription"
+        },
+        {
+          "label": "Plan versions",
+          "model": "@happyvertical/smrt-subscriptions:SubscriptionPlanVersion",
+          "icon": "fileText",
+          "description": "Every set of terms a plan has had, and from when each applied.",
+          "noun": "plan version"
+        },
+        {
+          "label": "Charges",
+          "model": "@happyvertical/smrt-subscriptions:ClientCharge",
+          "icon": "receipt",
+          "description": "What each subscriber used and what it cost them.",
+          "noun": "charge"
+        }
+      ],
+      "requires": [],
+      "section": {
+        "id": "sales",
+        "label": "Sales",
+        "icon": "shoppingBag",
+        "description": "Customers, orders and quotes: everything you sell."
+      },
+      "options": {
+        "@happyvertical/smrt-subscriptions:SubscriptionPlan": {
+          "fields": {
+            "name": {
+              "order": 1
+            },
+            "planKey": {
+              "label": "Plan code",
+              "order": 2
+            },
+            "description": {
+              "order": 3
+            },
+            "status": {
+              "order": 4
+            },
+            "priceAmount": {
+              "label": "Price (in cents)",
+              "order": 5
+            },
+            "currency": {
+              "order": 6
+            },
+            "billingInterval": {
+              "label": "Billed every",
+              "order": 7
+            },
+            "pricingMode": {
+              "label": "How it is priced",
+              "order": 8
+            },
+            "minimumAmount": {
+              "label": "Minimum (in cents)",
+              "visibility": "advanced"
+            },
+            "suggestedAmount": {
+              "label": "Suggested (in cents)",
+              "visibility": "advanced"
+            },
+            "sortOrder": {
+              "label": "Position in list",
+              "visibility": "advanced"
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            },
+            "features": {
+              "visibility": "hidden"
+            },
+            "thresholds": {
+              "visibility": "hidden"
+            },
+            "externalProvider": {
+              "visibility": "hidden"
+            },
+            "providerProductId": {
+              "visibility": "hidden"
+            },
+            "providerPriceId": {
+              "visibility": "hidden"
+            },
+            "stripeProductId": {
+              "visibility": "hidden"
+            },
+            "stripePriceId": {
+              "visibility": "hidden"
+            },
+            "metadata": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-subscriptions:SubscriptionPlanVersion": {
+          "fields": {
+            "planId": {
+              "label": "Plan",
+              "order": 1
+            },
+            "version": {
+              "label": "Version number",
+              "order": 2
+            },
+            "effectiveFrom": {
+              "label": "In force from",
+              "order": 3
+            },
+            "name": {
+              "order": 4
+            },
+            "status": {
+              "order": 5
+            },
+            "priceAmount": {
+              "label": "Price (in cents)",
+              "order": 6
+            },
+            "currency": {
+              "order": 7
+            },
+            "billingInterval": {
+              "label": "Billed every",
+              "order": 8
+            },
+            "planKey": {
+              "label": "Plan code",
+              "visibility": "advanced"
+            },
+            "pricingMode": {
+              "label": "How it is priced",
+              "visibility": "advanced"
+            },
+            "minimumAmount": {
+              "label": "Minimum (in cents)",
+              "visibility": "advanced"
+            },
+            "suggestedAmount": {
+              "label": "Suggested (in cents)",
+              "visibility": "advanced"
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            },
+            "features": {
+              "visibility": "hidden"
+            },
+            "thresholds": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-subscriptions:TenantSubscription": {
+          "fields": {
+            "planId": {
+              "label": "Plan",
+              "order": 1
+            },
+            "status": {
+              "order": 2
+            },
+            "startedAt": {
+              "label": "Started on",
+              "order": 3
+            },
+            "currentPeriodStart": {
+              "label": "Current period starts",
+              "order": 4
+            },
+            "currentPeriodEnd": {
+              "label": "Current period ends",
+              "order": 5
+            },
+            "trialEndsAt": {
+              "label": "Trial ends",
+              "order": 6
+            },
+            "cancelAtPeriodEnd": {
+              "label": "Cancel at end of period",
+              "order": 7
+            },
+            "canceledAt": {
+              "label": "Cancelled on",
+              "visibility": "advanced"
+            },
+            "agreedAmount": {
+              "label": "Agreed amount (in cents)",
+              "visibility": "advanced"
+            },
+            "subscriberKind": {
+              "label": "Subscriber type",
+              "visibility": "advanced"
+            },
+            "subscriberExternalId": {
+              "label": "Outside subscriber",
+              "visibility": "advanced"
+            },
+            "planVersionId": {
+              "label": "Plan version",
+              "visibility": "advanced",
+              "locked": true
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            },
+            "planVersionPinnedAt": {
+              "visibility": "hidden"
+            },
+            "planVersionPinReason": {
+              "visibility": "hidden"
+            },
+            "planVersionPinNote": {
+              "visibility": "hidden"
+            },
+            "retainsPaidPeriod": {
+              "visibility": "hidden"
+            },
+            "externalProvider": {
+              "visibility": "hidden"
+            },
+            "stripeCustomerId": {
+              "visibility": "hidden"
+            },
+            "stripeSubscriptionId": {
+              "visibility": "hidden"
+            },
+            "stripeCheckoutSessionId": {
+              "visibility": "hidden"
+            },
+            "metadata": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-subscriptions:ClientCharge": {
+          "fields": {
+            "metricKey": {
+              "label": "What was used",
+              "order": 1
+            },
+            "quantity": {
+              "label": "How much",
+              "order": 2
+            },
+            "amount": {
+              "label": "Amount (in cents)",
+              "order": 3
+            },
+            "currency": {
+              "order": 4
+            },
+            "status": {
+              "order": 5
+            },
+            "approvedAt": {
+              "label": "Approved on",
+              "order": 6
+            },
+            "serviceKey": {
+              "label": "Service",
+              "visibility": "advanced"
+            },
+            "provider": {
+              "visibility": "advanced"
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            },
+            "usageEventId": {
+              "visibility": "hidden"
+            },
+            "usageTenantId": {
+              "visibility": "hidden"
+            },
+            "subscriberKind": {
+              "visibility": "hidden"
+            },
+            "subscriberExternalId": {
+              "visibility": "hidden"
+            },
+            "projectId": {
+              "visibility": "hidden"
+            },
+            "workRefType": {
+              "visibility": "hidden"
+            },
+            "workRefId": {
+              "visibility": "hidden"
+            },
+            "pricingRuleId": {
+              "visibility": "hidden"
+            },
+            "priceBookId": {
+              "visibility": "hidden"
+            },
+            "pricingSnapshot": {
+              "visibility": "hidden"
+            }
+          }
+        }
+      },
+      "help": {
+        "markdown": "## Overview\n\nSubscriptions is where you sell plans that renew. A plan says what it costs,\nhow often it bills and whether it is free, a fixed price or pay what you can.\nA subscription joins a subscriber to a plan and shows where it stands, from\ntrial to active to cancelled. Every time you change a plan's terms, the\nearlier terms are kept as a plan version, so a subscriber who already paid for\na period keeps what they paid for until it renews. Charges show what each\nsubscriber used and what it cost them.\n\nAll amounts are whole numbers of cents, with no decimal point.\n\n## Tasks\n\n### Set up a plan\n\n1. Open the plans and choose **New**.\n2. Type the **{field:SubscriptionPlan.name}** customers will see and a short **{field:SubscriptionPlan.planKey}** such as \"starter\".\n3. Choose **{field:SubscriptionPlan.pricingMode}**: free, a fixed price, or pay what you can. This cannot change once the plan is saved; make a new plan instead.\n4. For a fixed price, enter the **{field:SubscriptionPlan.priceAmount}** in cents and the **{field:SubscriptionPlan.currency}**.\n5. Set how often it bills in **{field:SubscriptionPlan.billingInterval}**.\n6. Set the **{field:SubscriptionPlan.status}** to active when it is ready to sell.\n7. Save.\n\n### Change a plan's price or terms\n\n1. Open the plan and edit the **{field:SubscriptionPlan.priceAmount}**, **{field:SubscriptionPlan.billingInterval}** or **{field:SubscriptionPlan.status}**.\n2. Save. The new terms apply to new subscribers and to existing ones from their next renewal; a period already paid for keeps its old terms.\n\n### Retire a plan\n\n1. Open the plan and set its **{field:SubscriptionPlan.status}** to archived.\n2. Save. No one new can subscribe to it; existing subscribers keep going until they cancel.\n\n### Subscribe someone to a plan\n\n1. Open the subscriptions and choose **New**.\n2. Pick the **{field:TenantSubscription.planId}**.\n3. Enter the day it **{field:TenantSubscription.startedAt}** and, if there is a free trial, when the **{field:TenantSubscription.trialEndsAt}**.\n4. Save. The **{field:TenantSubscription.status}** shows where the subscription stands once it has been paid for.\n\n### See where a subscription stands\n\n1. Open the subscriptions and find the one you want.\n2. The **{field:TenantSubscription.status}** shows whether it is still incomplete, on trial, active, past due, unpaid or cancelled.\n3. **{field:TenantSubscription.currentPeriodStart}** and **{field:TenantSubscription.currentPeriodEnd}** show the period that has been paid for.\n\n### Cancel a subscription\n\n1. Open the subscription.\n2. Tick **{field:TenantSubscription.cancelAtPeriodEnd}** so it runs out when the current period ends instead of renewing.\n3. Save.\n\n### Look up the terms a subscriber was sold\n\nPlan versions are written automatically whenever a plan is saved with changed\nterms; you cannot add or edit them here.\n\n1. Open the plan versions and find the **{field:SubscriptionPlanVersion.planId}** you are interested in.\n2. Each row shows the **{field:SubscriptionPlanVersion.version}** and the date it was **{field:SubscriptionPlanVersion.effectiveFrom}**.\n3. Read the **{field:SubscriptionPlanVersion.priceAmount}**, **{field:SubscriptionPlanVersion.currency}** and **{field:SubscriptionPlanVersion.billingInterval}** that applied under it.\n\n### See what a subscriber was charged\n\nCharges are created by the usage and billing service as usage is recorded;\nyou cannot add or edit them here.\n\n1. Open the charges.\n2. Each row shows **{field:ClientCharge.metricKey}**, **{field:ClientCharge.quantity}** and the **{field:ClientCharge.amount}** in cents.\n3. The **{field:ClientCharge.status}** shows whether the charge is still a draft, approved or adjusted.\n",
+        "fieldRefs": [
+          "ClientCharge.amount",
+          "ClientCharge.metricKey",
+          "ClientCharge.quantity",
+          "ClientCharge.status",
+          "SubscriptionPlan.billingInterval",
+          "SubscriptionPlan.currency",
+          "SubscriptionPlan.name",
+          "SubscriptionPlan.planKey",
+          "SubscriptionPlan.priceAmount",
+          "SubscriptionPlan.pricingMode",
+          "SubscriptionPlan.status",
+          "SubscriptionPlanVersion.billingInterval",
+          "SubscriptionPlanVersion.currency",
+          "SubscriptionPlanVersion.effectiveFrom",
+          "SubscriptionPlanVersion.planId",
+          "SubscriptionPlanVersion.priceAmount",
+          "SubscriptionPlanVersion.version",
+          "TenantSubscription.cancelAtPeriodEnd",
+          "TenantSubscription.currentPeriodEnd",
+          "TenantSubscription.currentPeriodStart",
+          "TenantSubscription.planId",
+          "TenantSubscription.startedAt",
+          "TenantSubscription.status",
+          "TenantSubscription.trialEndsAt"
+        ]
+      },
+      "demo": {
+        "mode": "server",
+        "reasons": [
+          "Needs a server because its package does not build for a browser: core migrations (node:crypto, node:os); and its package depends on @happyvertical/smrt-tenancy, which do not build for a browser (#3624, #3626)."
+        ]
+      }
+    }
+  ],
   "smrtDependencies": [
     "@happyvertical/smrt-core",
     "@happyvertical/smrt-tenancy"