Skip to main content
PATCH
/
customers
/
{customer_id}
Update a customer
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Jo Brown-Anderson'})
};

fetch('https://api.paddle.com/customers/{customer_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
    "status": "active",
    "custom_data": null,
    "name": "Jo Brown-Anderson",
    "email": "[email protected]",
    "marketing_consent": false,
    "locale": "en",
    "created_at": "2024-04-11T15:57:24.813Z",
    "updated_at": "2024-04-11T15:59:56.658719Z",
    "import_meta": null
  },
  "meta": {
    "request_id": "bfa19139-37cc-48ef-8e75-215587e71ab2"
  }
}

Authorizations

Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

customer_id
string
required

Paddle ID of the customer entity to work with.

Example:

"ctm_01gw1xk43eqy2rrf0cs93zvm6t"

Body

application/json

Represents a customer entity when updating customers.

name
string | null

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

Maximum string length: 1024
email
string<email>

Email address for this customer.

Required string length: 1 - 320
status
enum<string>

Whether this entity can be used in Paddle.

Available options:
active,
archived
custom_data
Custom data · object

Your own structured key-value data.

Example:
{ "customer_reference_id": "abcd1234" }
locale
string
default:en

Valid IETF BCP 47 short form locale tag.

Response

OK

data
Customer · object
required

Represents a customer entity.

meta
Meta · object
required

Information about this response.