Account2

Addresses4

Adjustments3

API root1

Businesses4

Checkout domains4

Client tokens4

Countries1

Currencies1

Customer portals1

Customers6

Discount groups4

Discounts4

Event types1

Events1

IP addresses1

Metrics9

Notification logs1

Notification settings5

Notifications3

Payment methods3

Prices4

Pricing preview1

Products4

Reports4

Settings18

Simulation run events3

Simulation runs3

Simulation types1

Simulations4

Subscription history1

Subscriptions11

Transactions7

Verifications2

Webhooks

Addresses3

Adjustments2

API keys6

Businesses3

Client tokens3

Customers3

Discount groups2

Discounts3

Payment methods2

Payouts2

Prices3

Products3

Reports2

Subscriptions9

Transactions10

Customers

Create a customer

Changed on Feb 2, 2026

Creates a new customer.

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

post/customers

Request

Base URL
https://sandbox-api.paddle.com
Auth
HTTP bearer

Request body

idstring

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

namestring

Full name.

emailstring email required

Email address for this entity.

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.

custom_dataCustomData

Your own structured key-value data.

localestring

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

Example request

{
  "id": "ctm_01grnn4zta5a1mf02jjze7y2ys",
  "email": "test@paddle.com",
  "custom_data": {
    "customer_reference_id": "abcd1234"
  },
  "import_meta": {
    "external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
    "imported_from": "paddle_classic"
  }
}

Response

The request has succeeded and a new resource has been created as a result.

Example response

{
  "data": {
    "id": "ctm_01grnn4zta5a1mf02jjze7y2ys",
    "email": "test@paddle.com",
    "custom_data": {
      "customer_reference_id": "abcd1234"
    },
    "created_at": "2024-10-12T07:20:50.52Z",
    "updated_at": "2024-10-13T07:20:50.52Z",
    "import_meta": {
      "external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
      "imported_from": "paddle_classic"
    }
  },
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes

Feb 2, 2026v19ba8be0f2006 Revision changes
- breaking
  request body became required
- breaking
  added to the request property allOf list
- breaking
  added to the request property allOf list
- breaking
  removed subschema #2 from the request property oneOf list
- breaking
  removed subschema #2 from the request property oneOf list
- breaking
  removed subschema #2 from the request property oneOf list
- breaking
  the request property type changed from string to no type, and format from email to no format
- breaking
  the / response property's maxLength was unset from 320 for the response status
- breaking
  the / response property's minLength was decreased from 1 to 0 for the response status
- breaking
  the / response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the / response's property type changed from string to no type, and format from email to no format for status
- breaking
  the / response's property type changed from string to no type for status
- breaking
  the / response's property type changed from string to no type for status
- breaking
  the / response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  the request optional property became not read-only
- info
  the request optional property became not read-only
- info
  added subschema #2 to the request property anyOf list
- info
  added subschema #2 to the request property anyOf list
- info
  added subschema #2 to the request property anyOf list
- info
  the request property's minLength was decreased from 1 to 0
- info
  removed the pattern ^ctm_[a-z\d]{26}$ from the request property
- info
  the response optional property / became not read-only for the status
- info
  the response optional property / became not read-only for the status
- info
  added to the response property allOf list for the response status
- info
  added to the / response property allOf list for the response status
- info
  added to the / response property allOf list for the response status
- info
  added to the / response property allOf list for the response status
- info
  added to the / response property allOf list for the response status
- info
  added to the / response property allOf list for the response status
- info
  added subschema #2 to the / response property anyOf list for the response status
- info
  added subschema #2 to the / response property anyOf list for the response status
- info
  added subschema #2 to the / response property anyOf list for the response status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  removed the active enum value from the / response property for the response status
- info
  removed the archived enum value from the / response property for the response status
- info
  removed subschema #2 from the / response property oneOf list for the response status
- info
  removed subschema #2 from the / response property oneOf list for the response status
- info
  removed subschema #2 from the / response property oneOf list for the response status
- info
  the / response's property pattern ^ctm_[a-z\d]{26}$ was removed for the status
Apr 25, 2025v1c4b1322e66ca Revision changes
- breaking
  the request property's maxLength was decreased to 320
- breaking
  the request property's minLength was increased from 0 to 1

Operation history (4 revisions)