AApt Commerce
Sign inGet started
Show for

Managing Customers

Create and list merchant-scoped payer records in D1 via GET/POST/PATCH/DELETE /api/v1/customers. Alpha does not vault cards, emit customer.* webhooks, or offer a payer portal.

Creating a Customer

const customer = await apt.customers.create({
  email: 'jane@example.com',
  name: 'Jane Doe',
  phone: '+1-555-0123',
  metadata: { plan: 'pro' },
});

console.log(customer.id); // "cust_abc123"

What is not in this slice

Do not send PAN or attach payment methods through this API. Saved methods, payer portal sessions, and customer.* events are out of scope. DELETE requires session step-up (scope: customers.delete). Duplicate email on the same merchant returns 409.

Listing & Searching Customers

// List with pagination
const customers = await apt.customers.list({ limit: 25 });

// Search by email
const results = await apt.customers.list({
  email: 'jane@example.com',
});

Customer Portal

Not implemented. There is no payer self-service portal in Alpha.