---
updatedAt: 2026-04-07T00:21:56.000Z
agentTools:
  projectIndex: https://docs.pelcro.com/llms.txt
---

# Customers

Create and manage customer accounts with profiles, metadata, marketing preferences, and payment methods.

## Overview

Customers are the people who access your content and purchase subscriptions. Each customer has a profile with contact information, marketing preferences, and custom metadata. Customers can have multiple addresses, payment methods, and subscriptions.

Customers are scoped to your site - the same person with accounts on two different sites is treated as two separate customers.

***

## How It Works

1. **Create a customer** - Add a new customer with their email, name, and any custom metadata
2. **Enrich the profile** - Add addresses, payment methods, and organization associations
3. **Subscribe** - Create subscriptions and process payments for the customer

**Example:** A visitor registers on your site. You create a customer with their email and name. They add a credit card and subscribe to your premium plan. You store their company name in metadata for personalized communications.

***

## API Endpoints

| Method   | Endpoint                                | Description                                                           |
| -------- | --------------------------------------- | --------------------------------------------------------------------- |
| `GET`    | `/customers`                            | [List customers](https://docs.pelcro.com/reference/api-core-list-customers)                         |
| `POST`   | `/customers`                            | [Create customer](https://docs.pelcro.com/reference/api-core-create-customer)                       |
| `GET`    | `/customers/{id}`                       | [Get customer](https://docs.pelcro.com/reference/api-core-get-customer)                             |
| `PUT`    | `/customers/{id}`                       | [Update customer](https://docs.pelcro.com/reference/api-core-update-customer)                       |
| `DELETE` | `/customers/{id}`                       | [Delete customer](https://docs.pelcro.com/reference/api-core-delete-customer)                       |
| `POST`   | `/customers/credit_from_payment_method` | [Credit from payment method](https://docs.pelcro.com/reference/api-core-credit-from-payment-method) |
| `DELETE` | `/customers/{id}/metadata/{key}`        | [Delete customer metadata](https://docs.pelcro.com/reference/api-core-delete-customer-metadata)     |

***

## Important Behaviors

* **Soft delete**: Customers are soft-deleted. Deleting a customer cancels all active subscriptions and removes related addresses, payment methods, and memberships.
* **Email DNS validation**: Email DNS validation can be skipped per request via the `skip_email_dns_validations` flag.
* **Expandable relationships**: Multiple relationships can be expanded including `subscriptions` and `addresses`.
* **Stripe import**: When `import_payment_methods` is true, a Stripe payment gateway ID is required on the account.

***

## Customer Fields

| Field                     | Description                                       |
| ------------------------- | ------------------------------------------------- |
| `email`                   | Primary email address (unique per site)           |
| `first_name`, `last_name` | Customer's name                                   |
| `display_name`            | Public display name                               |
| `username`                | Unique username for login                         |
| `phone`                   | Phone number                                      |
| `metadata`                | Custom key-value data you define                  |
| `organization`            | Company or organization name                      |
| `language`                | Preferred language (`en`, `fr`, `it`, `ko`, `es`) |
| `timezone`                | Customer's timezone                               |

***

## Marketing Consent

Track customer consent for communications:

| Field            | Description                             |
| ---------------- | --------------------------------------- |
| `mail_marketing` | Email marketing opt-in (`true`/`false`) |
| `tele_marketing` | Phone marketing opt-in (`true`/`false`) |

***

## Expandable Relationships

When retrieving customers, you can include related data:

| Relationship    | Description                     |
| --------------- | ------------------------------- |
| `addresses`     | Shipping and billing addresses  |
| `defaultSource` | Default payment method          |
| `organization`  | Associated organization details |
| `subscriptions` | Active and past subscriptions   |

Use the `expand` parameter: `?expand=addresses,subscriptions`

# Sub pages

* [List customers](https://docs.pelcro.com/reference/api-core-list-customers.md)
* [Create customer](https://docs.pelcro.com/reference/api-core-create-customer.md)
* [Get customer](https://docs.pelcro.com/reference/api-core-get-customer.md)
* [Update customer](https://docs.pelcro.com/reference/api-core-update-customer.md)
* [Delete customer](https://docs.pelcro.com/reference/api-core-delete-customer.md)
* [Credit from payment method](https://docs.pelcro.com/reference/api-core-credit-from-payment-method.md)
* [Delete customer metadata](https://docs.pelcro.com/reference/api-core-delete-customer-metadata.md)

# Sibling pages

* [Overview](https://docs.pelcro.com/reference/api-core-intro.md)
* [Pagination](https://docs.pelcro.com/reference/api-core-pagination-limits.md)
* [Rate limits](https://docs.pelcro.com/reference/api-core-rate-limits.md)
* [Errors](https://docs.pelcro.com/reference/api-core-errors.md)
* [Sorting and filtering](https://docs.pelcro.com/reference/api-core-filtering-and-sorting.md)
* [Expanding relationships](https://docs.pelcro.com/reference/api-core-expanding-relationships.md)
* [Account](https://docs.pelcro.com/reference/api-core-account.md)
* [Analytics](https://docs.pelcro.com/reference/api-core-analytics.md)
* [Addresses](https://docs.pelcro.com/reference/api-core-addresses.md)
* [Bills](https://docs.pelcro.com/reference/api-core-bills.md)
* [Campaigns](https://docs.pelcro.com/reference/api-core-campaigns.md)
* [Charges](https://docs.pelcro.com/reference/api-core-charges.md)
* [Coupons](https://docs.pelcro.com/reference/api-core-coupons.md)
* [E-commerce](https://docs.pelcro.com/reference/api-core-ecommerce.md)
* [Exports](https://docs.pelcro.com/reference/api-core-export.md)
* [Invoices](https://docs.pelcro.com/reference/api-core-invoice.md)
* [Memberships](https://docs.pelcro.com/reference/api-core-membership.md)
* [Newsletters](https://docs.pelcro.com/reference/api-core-newsletters.md)
* [Organizations](https://docs.pelcro.com/reference/api-core-organizations.md)
* [Payment Methods](https://docs.pelcro.com/reference/api-core-source.md)
* [Plans](https://docs.pelcro.com/reference/api-core-plan.md)
* [Products](https://docs.pelcro.com/reference/api-core-product.md)
* [Refunds](https://docs.pelcro.com/reference/api-core-refunds.md)
* [Sites](https://docs.pelcro.com/reference/api-core-sites.md)
* [Subscriptions](https://docs.pelcro.com/reference/api-core-subscription.md)
* [Vendors](https://docs.pelcro.com/reference/api-core-vendors.md)
* [Webhooks](https://docs.pelcro.com/reference/api-core-webhook.md)