Customers

Customer objects store contact information and payment methods for recurring use.

The Customer object

{
  "id": "cus_abc123",
  "object": "customer",
  "name": "Aminata Koné",
  "email": "aminata@example.com",
  "phone": "+2250700000000",
  "currency": "XOF",
  "balance": 0,
  "metadata": {},
  "created": 1708300800
}

Endpoints

Method	Endpoint	Description
POST	/v1/customers	Create a customer
GET	/v1/customers/{id}	Retrieve a customer
PATCH	/v1/customers/{id}	Update a customer
DELETE	/v1/customers/{id}	Delete a customer
GET	/v1/customers	List customers
GET	/v1/customers/{id}/payment-methods	List saved payment methods

Create a Customer

POST /v1/customers

Parameter	Type	Required	Description
name	string		Customer's full name
email	string		Email address
phone	string		Phone number (E.164)
metadata	object		Key-value metadata