Paddle Billing
Search

Create a customer

posthttps://api.paddle.com/customers

Creates a new customer.

If successful, your response includes a copy of the new customer entity.

Request Body

emailstring<email>required

Email address for this customer.

namestring or null

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

custom_dataobject or null

Your own structured key-value data.

localestring

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

Response

dataobject

Represents a customer entity.

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.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.