feat: add free trial pricing table to emails when appropriate

.env.tpl

@@ -43,9 +43,16 @@ MAILSLURP_TIMEOUT = '120000'
 # Stripe
 # these values are from the Stripe test environment
 STRIPE_PRICING_TABLE_ID = 'prctbl_1NzhdvF6A5ufQX5vKNZuRhie'
+STRIPE_FREE_TRIAL_PRICING_TABLE_ID = 'prctbl_1QHa8sF6A5ufQX5vJ8SUZUjq'
 STRIPE_PUBLISHABLE_KEY = 'pk_test_51LO87hF6A5ufQX5viNsPTbuErzfavdrEFoBuaJJPfoIhzQXdOUdefwL70YewaXA32ZrSRbK4U4fqebC7SVtyeNcz00qmgNgueC'
 # this is used in tests and should always be set to the test env secret key
 STRIPE_TEST_SECRET_KEY = ''
+STRIPE_BILLING_METER_ID = ''
+STRIPE_BILLING_METER_EVENT_NAME = ''
 
 # Feature flags
 REQUIRE_PAYMENT_PLAN = 'true'
+
+# Referrals
+
+REFERRALS_ENDPOINT = 'https://staging.referrals.storacha.network'

stacks/upload-api-stack.js

@@ -57,7 +57,7 @@
   const git = getGitInfo()
   const ucanInvocationPostbasicAuth = new Config.Secret(stack, 'UCAN_INVOCATION_POST_BASIC_AUTH')
 
   const apis = (customDomains ?? [undefined]).map((customDomain, idx) => {
     const hostedZone = customDomain?.hostedZone
     // the first customDomain will be web3.storage, and we don't want the apiId for that domain to have a second part, see PR of this change for context
     const apiId = [`http-gateway`, idx > 0 ? hostedZone?.replaceAll('.', '_') : '']
@@ -141,9 +141,11 @@
             REQUIRE_PAYMENT_PLAN: process.env.REQUIRE_PAYMENT_PLAN ?? '',
             UPLOAD_API_DID: process.env.UPLOAD_API_DID ?? '',
             STRIPE_PRICING_TABLE_ID: process.env.STRIPE_PRICING_TABLE_ID ?? '',
+            STRIPE_FREE_TRIAL_PRICING_TABLE_ID: process.env.STRIPE_FREE_TRIAL_PRICING_TABLE_ID ?? '',
             STRIPE_PUBLISHABLE_KEY: process.env.STRIPE_PUBLISHABLE_KEY ?? '',
             DEAL_TRACKER_DID: process.env.DEAL_TRACKER_DID ?? '',
             DEAL_TRACKER_URL: process.env.DEAL_TRACKER_URL ?? '',
+            REFERRALS_ENDPOINT: process.env.REFERRALS_ENDPOINT ?? '',
             CONTENT_CLAIMS_DID,
             CONTENT_CLAIMS_URL,
             CONTENT_CLAIMS_PROOF,

upload-api/functions/validate-email.jsx

@@ -11,6 +11,7 @@ import { createWorkflowStore } from '../buckets/workflow-store.js'
 import { createSubscriptionTable } from '../tables/subscription.js'
 import { createConsumerTable } from '../tables/consumer.js'
 import { createRevocationsTable } from '../stores/revocations.js'
+import { createReferralStore } from '../stores/referrals.js'
 import * as AgentStore from '../stores/agent.js'
 import { useProvisionStore } from '../stores/provisions.js'
 // eslint-disable-next-line import/extensions
@@ -90,7 +91,9 @@ function createAuthorizeContext() {
     UPLOAD_API_DID = '',
     PROVIDERS = '',
     STRIPE_PRICING_TABLE_ID = '',
+    STRIPE_FREE_TRIAL_PRICING_TABLE_ID = '',
     STRIPE_PUBLISHABLE_KEY = '',
+    REFERRALS_ENDPOINT = '',
     UCAN_LOG_STREAM_NAME = '',
     SST_STAGE = '',
     // set for testing
@@ -122,6 +125,7 @@ function createAuthorizeContext() {
     { region: AWS_REGION },
     { tableName: CUSTOMER_TABLE_NAME }
   )
+  const referralStore = createReferralStore({ endpoint: REFERRALS_ENDPOINT })
   const spaceMetricsTable = createSpaceMetricsTable(
     AWS_REGION,
     SPACE_METRICS_TABLE_NAME
@@ -171,8 +175,10 @@ function createAuthorizeContext() {
     ),
     rateLimitsStorage: createRateLimitTable(AWS_REGION, RATE_LIMIT_TABLE_NAME),
     customerStore,
+    referralStore,
     agentStore,
     stripePricingTableId: STRIPE_PRICING_TABLE_ID,
+    stripeFreeTrialPricingTableId: STRIPE_FREE_TRIAL_PRICING_TABLE_ID,
     stripePublishableKey: STRIPE_PUBLISHABLE_KEY,
   }
 }
@@ -183,7 +189,6 @@ function createAuthorizeContext() {
  * @param {import('aws-lambda').APIGatewayProxyEventV2} request
  */
 export async function validateEmailPost(request) {
-  console.log("VALIDATING EMAIL")
   const encodedUcan = request.queryStringParameters?.ucan
   if (!encodedUcan) {
     return toLambdaResponse(
@@ -192,13 +197,9 @@ export async function validateEmailPost(request) {
       )
     )
   }
-  console.log("CREATING CONTEXT")
-
   const context = createAuthorizeContext()
-  console.log("AUTHORIZING")
 
   const authorizeResult = await authorize(encodedUcan, context)
-  console.log("AUTHORIZED", JSON.stringify(authorizeResult))
 
   if (authorizeResult.error) {
     console.error(authorizeResult.error)
@@ -215,21 +216,28 @@ export async function validateEmailPost(request) {
   }
 
   const { email, audience, ucan } = authorizeResult.ok
-  console.log("CHECKING PLAN")
 
   const planCheckResult = await context.customerStore.get({
     customer: DidMailto.fromEmail(email),
   })
+  let isReferred = false
+  try {
+    // if we can find a referral code for this user, offer them a free trial
+    if ((await context.referralStore.getReferredBy(email)).refcode) {
+      isReferred = true
+    }
+  } catch (e){
+    // if we fail here, log the error and move on
+    console.warn('encountered an error checking the referrals service, please see the error logs for more information')
+    console.error(e)
+  }
   let stripePricingTableId
   let stripePublishableKey
-  console.log("CHECKED PLAN", JSON.stringify(planCheckResult))
 
   if (!planCheckResult.ok?.product) {
-    stripePricingTableId = context.stripePricingTableId
     stripePublishableKey = context.stripePublishableKey
+    stripePricingTableId = isReferred ? context.stripeFreeTrialPricingTableId : context.stripePricingTableId
   }
-
-
   return toLambdaResponse(
     new html.HtmlResponse(
       (
@@ -239,6 +247,7 @@ export async function validateEmailPost(request) {
           ucan={ucan}
           stripePricingTableId={stripePricingTableId}
           stripePublishableKey={stripePublishableKey}
+          isReferred={isReferred}
         />
       )
     )

upload-api/html-storacha/index.jsx

@@ -194,13 +194,15 @@ export const PendingValidateEmail = ({ autoApprove }) => (
  * @param {string} props.audience
  * @param {string} [props.stripePricingTableId]
  * @param {string} [props.stripePublishableKey]
+ * @param {boolean} [props.isReferred]
  */
 export const ValidateEmail = ({
   ucan,
   email,
   audience,
   stripePricingTableId,
   stripePublishableKey,
+  isReferred
 }) => {
   const showPricingTable = stripePricingTableId && stripePublishableKey
   return (
@@ -220,9 +222,24 @@ export const ValidateEmail = ({
         </div>
         {showPricingTable && (
           <div class="box">
-            <p>
-              In order to upload data you need to sign up for a billing plan:
-            </p>
+            {isReferred ? (
+              <>
+                <p>
+                  Congratulations! You are eligible for a free trial of our Lite or Business subscriptions. That means
+                  we won&apos;t charge you anything today.
+                  If you choose a Lite plan, you will get two months for free! If you choose Business, you will get one month for free!
+                  We do need you to provide a valid credit card before we can start your
+                  trial - pick a plan below and complete the checkout flow to get started!
+                </p>
+                <p>
+                  Please note that after your free trial ends, you will be charged 10 USD per month for Lite or 100 USD per month for Business tier.
+                </p>
+              </>
+            ) : (
+              <p>
+                In order to upload data you need to sign up for a billing plan:
+              </p>
+            )}
             <stripe-pricing-table
               pricing-table-id={stripePricingTableId}
               publishable-key={stripePublishableKey}
@@ -233,7 +250,7 @@ export const ValidateEmail = ({
         <div class="box">
           <p>
             By registering with Storacha you agree to the Storacha{' '}
-            <a href="https://web3.storage/docs/terms/">Terms of Service</a>.
+            <a href="https://docs.storacha.network/terms/">Terms of Service</a>.
           </p>
         </div>
         <details class="box">

upload-api/stores/referrals.js

@@ -0,0 +1,15 @@
+/**
+ * Abstraction layer for referrals.
+ *
+ * @param {object} [options]
+ * @param {string} [options.endpoint]
+ * @returns {import("../types").ReferralsStore}
+ */
+export function createReferralStore(options = {}) {
+  return {
+    async getReferredBy(email) {
+      const result = await fetch(`${options.endpoint}/referredby/${email}`)
+      return await result.json()
+    }
+  }
+}

upload-api/types.ts

@@ -287,4 +287,12 @@ export interface BillingProvider {
   createAdminSession: (customer: AccountDID, returnURL: string) => Promise<Result<PlanCreateAdminSessionSuccess, PlanCreateAdminSessionFailure>>
 }
 
+export interface Referral {
+  refcode: string
+}
+
+export interface ReferralsStore {
+  getReferredBy: (email: string) => Promise<Referral>
+}
+
 export {}