Customers

Customer entities hold information about the people and businesses that make purchases. They're related to addresses and businesses.

Customers are the people and businesses that buy the products listed in your catalog.

Paddle automatically creates customers for you as part of the checkout, or you can create and manage them using the Paddle dashboard or API.

Customer entities hold information like:

Who's being billed.
What their email address is.
Whether they've opted-in to marketing.

Customers have two sub-entities:

Addresses, which hold information about customer billing addresses
Businesses, which hold information that you need when working with a business

Customers, addresses, and businesses work with checkouts, transactions, and subscriptions to bill for products and prices.

Learn how to create a complete customer with a related address and business. See: Work with customers

There's no delete operation for customers. Use the update a customer operation to archive customers when you no longer need them. See: Delete entities

Attributes

idstring

Unique Paddle ID for this customer entity, prefixed with ctm_.

namestring or null

Full name of this customer. Required when creating transactions where collection_mode is manual (invoices).

emailstring<email>

Email address for this customer.

marketing_consentboolean

Whether this customer opted into marketing from you. false unless customers check the marketing consent box when using Paddle Checkout. Set automatically by Paddle.

statusstring

Whether this entity can be used in Paddle.

custom_dataobject or null

Your own structured key-value data.

localestring

Valid IETF BCP 47 short form locale tag. If omitted, defaults to en.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

import_metaobject or null

Import information for this entity. null if this entity is not imported.

imported_fromstring

Name of the platform where this entity was imported from.

external_idstring or null

Reference or identifier for this entity from the solution where it was imported from.

List customers

gethttps://api.paddle.com/customers

Create a customer

posthttps://api.paddle.com/customers

Get a customer

gethttps://api.paddle.com/customers/{customer_id}

Update a customer

patchhttps://api.paddle.com/customers/{customer_id}

List credit balances for a customer

gethttps://api.paddle.com/customers/{customer_id}/credit-balances

Generate an authentication token for a customer

posthttps://api.paddle.com/customers/{customer_id}/auth-token