Key concepts
- Customer key: A unique identifier you assign (e.g., account ID, email)
- Partner attribution: Links a customer to the partner who referred them
- Tags: Labels for segmenting and filtering customers
Available endpoints
List customers
Retrieve all customers with pagination and filtering
Get customer
Get a specific customer’s details and tags
Create customer
Register a customer and attribute them to a partner
Update customer
Modify customer details or tags
Delete customer
Permanently remove a customer
Suspend / Approve
Temporarily pause or reactivate a customer
Customer lifecycle
- Created—customer signs up via referral link or is created via API.
- Active—transactions generate commissions for the attributed partner.
- Suspended—temporarily paused, transactions don’t generate commissions.
- Deleted—permanently removed along with transaction history.
For refer-a-friend programs, customer management uses different field names and additional endpoints. See the refer-a-friend customers section.
