The customer object
string
Unique identifier. Prefixed with
cus_.string
Always
"customer".string
Email address of the customer.
string
Full name of the customer.
string
Phone number of the customer.
string
URL to the customer’s profile image.
array
Stellar wallets linked to this customer.
object
Arbitrary key-value data you can attach to the customer.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
Create a customer
POST /customers
Creates one customer. You can also pass an array to create multiple at once.
Body
string
required
Customer’s email address.
string
required
Customer’s full name.
string
Customer’s phone number.
string
URL to a profile image.
object
Arbitrary key-value string pairs to attach to the customer.
List customers
GET /customers
Returns all customers for your account.
Retrieve a customer
GET /customers/{customer_id}
Update a customer
PUT /customers/{customer_id}
Body
string
New email address.
string
New name.
string
New phone number.
string
New image URL.
object
Merged with existing metadata.
Delete a customer
DELETE /customers/{customer_id}
Returns null on success.