Skip to content

Viewing Customers

Navigate to Customers in the sidebar to see all customers for your account. The list is paginated and sorted by creation date by default.

Search fields:

  • Name
  • Email
  • Reference (your internal identifier)
  • External reference ID (cus_xxx)
  • Custom attribute values

Click any customer to open their detail view, which shows:

  • Core fields — name, email, reference, status, currency, timezone
  • Contact details — phone numbers, billing address, shipping address
  • Payment instruments — saved cards and bank accounts
  • Payment plans — active and historical plans
  • Payment history — all payment intents associated with this customer
  • Activity log — a record of all changes to the customer record
Status Description
active The usual status for a customer
hold Created with a payment method still to be collected
cancelled Set on some older customers; no longer set by ElasticPay

Status is informational and can’t be edited. It doesn’t start or stop payments: a customer’s plans charge according to each plan’s own state, whatever the customer’s status.

A customer is on hold when they were created with a payment method still to be collected, for example when you chose Email the customer or haven’t yet completed Collect Payment Details. Their plans wait in draft until the method arrives. Once it’s collected, the customer returns to active and the draft plans are activated automatically.

A failed payment method doesn’t change the customer’s status. It suspends the plans that use it instead; see handling failures.

The external reference ID (cus_xxx) is the stable identifier for a customer across the API:

Terminal window
curl https://staging-api.elasticpay.co/api/v1/customers/cus_0abc123def456 \
-H "Authorization: Bearer sk_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"