Customers

Generate an authentication token for a customer

Changed on

Generates an authentication token for a customer. You can pass a generated authentication token to Paddle.js when opening a checkout to let customers work with saved payment methods.

Authentication tokens are temporary and shouldn't be cached. They're valid until the expires_at date returned in the response.

post/customers/{customer_id}/auth-token

Request

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

Path parameters

customer_idstring required

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

Example:ctm_01grnn4zta5a1mf02jjze7y2ys

Paddle ID of the customer entity to work with.

Response

The request has succeeded.

Example response

{
  "data": {
    "customer_auth_token": "pca_01hstrngzv6v4ard25jgvywwqq_01hsgrwf0ev6gxm74bp0gebxas_o7scuiadqtvbtspkmbwfnyrvyrq3zig6",
    "expires_at": "2024-10-12T07:20:50.52Z"
  },
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes

    • breaking

      added the pattern ^ctm_[a-z\d]{26}$ to the path request parameter customer_id

    • breaking

      added the new path request parameter customer_id

    • breaking

      the / response's property type changed from string to no type, and format from date-time to no format for status

    • info

      added to the / response property allOf list for the response status

    • info

      the response property / became required for the status