Skip to main content
The Customers API provides endpoints for creating and managing customer profiles within Commerce V1. Customer records serve as the foundation for storing payment methods, managing payment setups, and tracking customer-specific payment history.

​
Customer Management

Create and maintain customer profiles with relevant billing and contact information. Each customer is identified by a unique UUID that can be used across all payment and payment method operations. Key capabilities:
  • Create customers: Register new customers with billing and contact details
  • Update customers: Modify customer information as needed
  • Retrieve customers: Access individual customer details or list all customers
  • Delete customers: Remove customer records when no longer needed

​
Customer Relationships

Customer records link to several related resources:
  • Payment methods: Cards, SEPA mandates, and ACH mandates associated with the customer
  • Payment setups: In-progress payment method setup flows
  • Payments: Transaction history for the customer
When you create a payment using a stored payment method, the customer ID ensures proper association and enables features like recurring billing and one-click checkout.

​
Customer Events

Customer creation triggers the CustomerCreated event, allowing your system to respond to new customer registrations. Payment method setup state changes trigger the PaymentMethodSetupChanged event for tracking customer payment method configuration.

​
Data Privacy

Customer data is stored securely within Commerce V1’s infrastructure. When integrating with the Customers API, ensure compliance with applicable data protection regulations (GDPR, CCPA, etc.) in your jurisdiction.