Customers
Retrieve a customer
Fetches one customer by id, including their country, VAT status and the test clock they are attached to.
GET/v1/customers/{customer_id}
Parameters
| Parameter | Description |
|---|---|
| customer_idstring · pathrequired | No description in the spec. |
Returns
The customer object. A customer belonging to the other mode, or to another account, is a 404 rather than a 403, so no id existence leaks across tenants.
Deleted and purged customers are a 404 here too. Deletion is soft and a GDPR purge only anonymises the personal fields, so the row stays behind and their invoices and payments still resolve; the customer itself stops being readable.
Test it
Compare the response against the same record in the console under Customers. The two views are the same row.
Errors
| Status | Cause |
|---|---|
| 401 | Missing or invalid API key. |
| 403 | Key is missing the customers:read scope. |
| 404 | No such object, or it belongs to the other mode. |
| 422 | Validation Error |
| 429 | Rate limited. Back off and retry. |
Other customers operations
- List customers GET /v1/customers
- Create a customer POST /v1/customers
- Delete customer DELETE /v1/customers/{customer_id}
- Update customer POST /v1/customers/{customer_id}
- Purge customer POST /v1/customers/{customer_id}/purge
- Set customer VAT number POST /v1/customers/{customer_id}/vat_number
BillKit