@@ -48,7 +48,7 @@ const outlit = new Outlit({
4848// Track an event
4949outlit .track ({
5050 email: ' user@example.com' ,
51- customerId: ' cust_123' ,
51+ customerId: ' cust_123' , // Your app's account/workspace/customer ID
5252 eventName: ' subscription_upgraded' ,
5353 properties: {
5454 fromPlan: ' starter' ,
@@ -104,7 +104,7 @@ Track a custom event for a user, a customer, or both.
104104outlit .track ({
105105 email: ' jane@acme.com' ,
106106 userId: ' usr_12345' , // optional if email provided
107- customerId: ' cust_123' ,
107+ customerId: ' cust_123' , // Your app's account/workspace/customer ID
108108 eventName: ' report_exported' ,
109109 properties: {
110110 reportType: ' sales' ,
@@ -155,7 +155,7 @@ Update user traits without tracking an event. Customer metadata can be included
155155outlit .identify ({
156156 email: ' jane@acme.com' ,
157157 userId: ' usr_12345' ,
158- customerId: ' cust_123' ,
158+ customerId: ' cust_123' , // Your app's account/workspace/customer ID
159159 customerTraits: {
160160 plan: ' enterprise' ,
161161 seats: 50
@@ -224,7 +224,7 @@ Mark an account as trialing.
224224
225225``` typescript
226226outlit .customer .trialing ({
227- customerId: ' cust_123' ,
227+ customerId: ' cust_123' , // Your app's account/workspace/customer ID
228228 properties: { trialEndsAt: ' 2024-02-15' }
229229})
230230```
@@ -235,7 +235,7 @@ Mark an account as paying.
235235
236236``` typescript
237237outlit .customer .paid ({
238- customerId: ' cust_123' ,
238+ customerId: ' cust_123' , // Your app's account/workspace/customer ID
239239 properties: { plan: ' pro' , amount: 99 }
240240})
241241```
@@ -246,7 +246,7 @@ Mark an account as churned.
246246
247247``` typescript
248248outlit .customer .churned ({
249- customerId: ' cust_123' ,
249+ customerId: ' cust_123' , // Your app's account/workspace/customer ID
250250 properties: { reason: ' cancelled_by_user' }
251251})
252252```
@@ -520,7 +520,7 @@ const outlit = new Outlit(options)
520520
521521const trackOptions: ServerTrackOptions = {
522522 email: ' user@test.com' ,
523- customerId: ' cust_123' ,
523+ customerId: ' cust_123' , // Your app's account/workspace/customer ID
524524 eventName: ' test' ,
525525 properties: { key: ' value' }
526526}
@@ -537,7 +537,7 @@ outlit.user.activate(stageOptions)
537537
538538// Account billing options
539539const billingOptions: BillingOptions = {
540- customerId: ' cust_123' ,
540+ customerId: ' cust_123' , // Your app's account/workspace/customer ID
541541 properties: { plan: ' pro' }
542542}
543543
0 commit comments