Customers

The Customers feature provides a centralized registry for your users. By linking payments to customer profiles, you unlock unified analytics, personalized communications, and streamlined recurring billing.

🎯 Why Use Customer Profiles?

🛠️ Creating a Customer

Via SDK

import { Reevit } from '@reevit/node';

const customer = await reevit.customers.create({
  external_id: 'usr_1234', // Your internal user ID
  email: 'ada@example.com',
  name: 'Ada Lovelace',
  phone: '+233501234567',
  tags: ['premium', 'early-adopter'],
  metadata: { plan: 'pro', signup_source: 'referral' }
});

Linking a Payment to a Customer

When creating a payment, include the customer_id:

await reevit.payments.create({
  amount: 15000,
  currency: 'GHS',
  customer_id: customer.id, // Link to customer profile
  // ...
});

📋 Field Reference

📊 Customer Analytics

The customer profile automatically aggregates:

• Total Spent: Sum of all successful payments.
• Payment Count: Number of transactions.
• Last Payment Date: When they last paid.
• Subscription Status: Active/cancelled recurring plans.

Fetch a customer's payment history:

const history = await reevit.customers.getPaymentHistory('cus_xyz123');
// [
//   { id: 'pay_001', amount: 5000, status: 'succeeded', created_at: '...' },
//   { id: 'pay_002', amount: 10000, status: 'succeeded', created_at: '...' }
// ]

Find your top customers by revenue:

const topCustomers = await reevit.customers.getTopCustomers({ limit: 10 });

🔗 The external_id Field

The external_id is critical for syncing Reevit with your internal systems.

• What it is: A unique identifier from your database (e.g., usr_abc123).
• Why use it: When a webhook fires, you can use the external_id to immediately look up the customer in your database without needing to map Reevit IDs.
• Lookup: GET /v1/customers?external_id=usr_abc123

✅ Best Practices

1. Always Set external_id: Use your internal user ID to keep systems in sync.
2. Use Tags for Segmentation: Apply tags like churned, active, trial to power analytics and workflows.
3. Store Contact Info: Providing email and phone enables automated receipt sending and SMS notifications.

📚 Related Resources