Customers

A customer is a record of someone who pays you: name, email, phone. Charges and payment sessions can point at a customer. Customer routes need an API key.

Routes

POST /customers
GET /customers: see Pagination.
GET /customers/{id}
PUT /customers/{id}
DELETE /customers/{id}

Fields you will use

Name
id
Type
string
Description
Starts with cus_. Set by the system.
Name
name
Type
string
Description
Name
email
Type
string
Description
Name
phone
Type
string
Description
Name
description
Type
string
Description
Name
address
Type
string
Description
Name
livemode
Type
boolean
Description
Set from the key you call with. Test and live customers are separate.
Name
created_at
Type
timestamp
Description

The object has more fields that mirror a card processor's customer record (for example balance, delinquent, tax_exempt). They are stored as you send them; nothing in Cari Finance acts on them.

Create a customer

curl https://api.cari.finance/customers \
  -H "Authorization: Bearer sk_test_YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Ada Lovelace", "email": "ada@example.com"}'