[ Web Proxy ]
URL:
Viewing: https://developer.paddle.com/api-reference/customers/create-customer [Back]  [Original]
Create a customer | Paddle Developer Docs

For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling append .md to any URL.

Skip to content
Paddle Docs home
Search Ask AI Toggle Theme svg]:px-3 hidden md:flex" href="https://login.paddle.com/start" data-auth-button="true" data-login-url="https://login.paddle.com/start" data-dashboard-url="https://vendors.paddle.com" data-dashboard-api="https://api.paddle.com/userinfo" data-astro-cid-mq3pp5jd="true"> Login

API reference

Overview
Home
API reference
Customers
svg]:px-2.5 h-8 gap-2 shadow-none md:h-7 md:text-[0.8rem]" href="https://god.gw.postman.com/run-collection/29428794-16aca740-3ad6-4c1a-97be-05dbc504b4c3?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29428794-16aca740-3ad6-4c1a-97be-05dbc504b4c3%26entityType%3Dcollection%26workspaceId%3D5ed2587a-f47e-43e0-810c-0c3e782bca12#?env%5BSandbox%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly9zYW5kYm94LWFwaS5wYWRkbGUuY29tIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifSx7ImtleSI6ImJlYXJlclRva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoic2VjcmV0In1d" target="_blank" rel="noopener noreferrer" title="Fork the Paddle Postman collection" data-postman-run-button="true" data-astro-cid-6ac4p433="true">

Create a customer

Creates a new customer.

POST /customers

Creates a new customer.

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

Requires customer.write permission.

Request body

namestring | null
Full name of this customer. Required when creating transactions where collection_mode is manual (invoices).
Max length: 1024
emailstring (email)required
Example: test@paddle.com
Email address for this customer.
Length: 1320
custom_dataobject | null
Example: {"customer_reference_id":"abcd1234"}
Your own structured key-value data.
localestring
Default: en
Valid IETF BCP 47 short form locale tag. If omitted, defaults to en.

Response (201)

dataobjectrequired
Represents a customer entity.
idstringrequired
Example: ctm_01grnn4zta5a1mf02jjze7y2ys
Unique Paddle ID for this customer entity, prefixed with ctm_.
Pattern: ^ctm_[a-z\d]{26}$
namestring | nullrequired
Full name of this customer. Required when creating transactions where collection_mode is manual (invoices).
Max length: 1024
emailstring (email)required
Example: test@paddle.com
Email address for this customer.
Length: 1320
marketing_consentbooleanrequired
Default: false
Whether this customer opted into marketing from you. false unless customers check the marketing consent box when using Paddle Checkout. Set automatically by Paddle.
statusstringrequired
Default: active
Whether this entity can be used in Paddle.
Values
  • active
    Entity is active and can be used.
  • archived
    Entity is archived, so can't be used.
custom_dataobject | nullrequired
Example: {"customer_reference_id":"abcd1234"}
Your own structured key-value data.
localestringrequired
Default: en
Valid IETF BCP 47 short form locale tag. If omitted, defaults to en.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
import_metaobject | nullrequired
Import information for this entity. null if this entity is not imported.
external_idstring | null
Example: 9b95b0b8-e10f-441a-862e-1936a6d818ab
Reference or identifier for this entity from the provider where it was imported from.
Length: 1200
imported_fromstringrequired
Example: paddle_classic
Name of the platform or provider where this entity was imported from.
Length: 1200
metaobjectrequired
Information about this response.
request_idstringrequired
Example: b15ec92e-8688-40d4-a04d-f44cbec93355
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Request Response
Request
{
  "email": "jo@example.com",
  "name": "Jo Brown"
}
{ "email": "jo@example.com", "name": "Jo Brown" }
Response
{
  "data": {
    "id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
    "status": "active",
    "custom_data": null,
    "name": "Jo Brown",
    "email": "jo@example.com",
    "marketing_consent": false,
    "locale": "en",
    "created_at": "2024-04-11T15:57:24.813Z",
    "updated_at": "2024-04-11T15:57:24.813Z",
    "import_meta": null
  },
  "meta": {
    "request_id": "9bcdcc29-e180-4055-ad3d-d37e5dc5e56d"
  }
}
{ "data": { "id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4", "status": "active", "custom_data": null, "name": "Jo Brown", "email": "jo@example.com", "marketing_consent": false, "locale": "en", "created_at": "2024-04-11T15:57:24.813Z", "updated_at": "2024-04-11T15:57:24.813Z", "import_meta": null }, "meta": { "request_id": "9bcdcc29-e180-4055-ad3d-d37e5dc5e56d" } }

Was this page helpful?

Yes, helpfulNo, not helpfulI have feedback
Paddle home
Status Security Changelog LLM benchmark Blog Contact
RSS Feed Run in Postman GitHub LinkedIn Twitter YouTube
Privacy policy Terms Manage cookies

Paddle.com Market Ltd. 20122026

Web Proxy Viewer  |  New URL  |  Original Page