> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.prolifi.io/endpoints/customers/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.prolifi.io/_mcp/server.

# Customers

Customers are the billable entities in Prolifi. Every subscription, invoice, and entitlement is tied to a customer.

## Endpoints

| Method   | Path              | Description                            |
| -------- | ----------------- | -------------------------------------- |
| `POST`   | `/customers`      | Create a new customer                  |
| `GET`    | `/customers`      | List customers (paginated)             |
| `GET`    | `/customers/{id}` | Get a customer by UUID or external\_id |
| `PATCH`  | `/customers/{id}` | Update a customer                      |
| `DELETE` | `/customers/{id}` | Archive a customer                     |

## Key concepts

* **External IDs**: Use the `external_id` field to link Prolifi customers to your application's user records. You can then retrieve customers by external\_id instead of UUID.
* **Name handling**: Provide a full `name` (which is split into `first_name` and `last_name`), or provide them separately.
* **Customer types**: If `company_name` is provided, the customer type is automatically set to `business`. Otherwise, it defaults to `individual`.
* **Archiving**: The `DELETE` endpoint archives the customer rather than permanently deleting it.

> Create and manage customer records


## API Docs

- Customers [Create a customer](https://docs.prolifi.io/endpoints/customers/create-customer.md)
- Customers [List customers](https://docs.prolifi.io/endpoints/customers/list-customers.md)
- Customers [Get a customer](https://docs.prolifi.io/endpoints/customers/get-customer.md)
- Customers [Update a customer](https://docs.prolifi.io/endpoints/customers/update-customer.md)
- Customers [Delete a customer](https://docs.prolifi.io/endpoints/customers/delete-customer.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.prolifi.io/endpoints/customers/openapi.json)
- [OpenAPI YAML](https://docs.prolifi.io/endpoints/customers/openapi.yaml)