Retrieve a customer
Returns one customer, with the metadata you stored on them. Only customers belonging to the key's merchant and mode are visible.
Returns one customer, with the metadata you stored on them. Only customers belonging to the key's merchant and mode are visible.
Authorization
secretKey Your secret key: sk_live_… or sk_test_….
In: header
Path Parameters
The customer's id, which starts with cus_.
^cus_[0-9a-f]{32}$Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/customers/cus_3f2b8c1e9a4d4e7b8c2a1d5e6f7a8b9c"{ "object": "customer", "customer_id": "cus_3f2b8c1e9a4d4e7b8c2a1d5e6f7a8b9c", "name": "string", "email": "user@example.com", "phone_number": "string", "metadata": { "property1": "string", "property2": "string" }, "created_at": "2019-08-24T14:15:22Z"}Create a customer POST
Saves a customer, so you can attach your own `metadata` before they pay and filter payments and subscriptions by `customer_id` afterwards. It is optional: a payment that succeeds matches a customer by lower-cased email within the same merchant and mode, and creates one when there is no match. `name` and `email` are required, the email is stored in lower case and must be free in this merchant and mode (`409 CUSTOMER_EXISTS`), and `phone_number` is E.164, like `+971501234567`. Send `Idempotency-Key` so a retried request does not save a second customer.
List customers GET
Lists customers, newest first, or finds one by `email`. One page carries `items`, `has_more` and `next_cursor`; pass `next_cursor` back as `cursor` for the next page. Only customers belonging to the key's merchant and mode are listed.