Skip to main content
POST
Update a customer

Authorizations

Authorization
string
header
required

A secret key, sk_test_... or sk_live_...; a publishable key (pk_...) on the browser routes only

Path Parameters

id
string
required
Required string length: 1 - 64

Body

application/json
name
string | null

The name shown in the Payra dashboard. null shows the email instead, or the reference.

Required string length: 1 - 200
Example:

"Ada Lovelace"

email
string<email> | null

Where Payra sends this customer's payment receipts, and the address that signs in to the customer portal. null removes it. Other addresses your team added in the dashboard are kept either way.

Maximum string length: 254
phone
string | null

E.164; null removes it.

Pattern: ^\+[1-9]\d{9,14}$
Example:

"+15555550123"

Response

The customer

object
enum<string>
required
Available options:
customer
id
string<uuid>
required

Pass it as customer on a payment method session, a checkout session or a payment.

Example:

"019e2b4c-7a1d-7c3e-9f20-5b8d4e6a1c30"

reference
string | null
required

Your own id for the customer; null for customers created in the Payra dashboard or by an ERP.

Example:

"user_48213"

name
string | null
required

The name shown in the Payra dashboard: the email, or the reference, when created without one.

Example:

"Ada Lovelace"

email
string | null
required
phone
string | null
required
Example:

"+15555550123"

created_at
string<date-time>
required
Example:

"2026-09-29T14:00:00.000Z"