Skip to main content
GET
/
customers
/
{customer_id}
Get a customer
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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_01hrffh7gvp29kc7xahm8wddwa",
    "status": "active",
    "custom_data": null,
    "name": "Sam Miller",
    "email": "[email protected]",
    "marketing_consent": false,
    "locale": "en",
    "created_at": "2024-03-08T16:49:53.691Z",
    "updated_at": "2024-04-11T16:03:57.924146Z",
    "import_meta": null
  },
  "meta": {
    "request_id": "aa0009cb-18f7-4538-b1cd-ad29d91cfaa7"
  }
}

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"

Response

OK

data
CustomerIncludes · object
required

Represents a customer entity with included entities.

meta
Meta · object
required

Information about this response.