Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Authorization: Bearer ck_test_… or ck_live_…. There is no other auth scheme — no query-string keys, no request signing, no OAuth.

Path Parameters

id
string<uuid>
required

Body

application/json

Partial at the top level only: omit a key and that document is untouched, supply one and it is replaced wholesale. There is no deep merge. null clears a document outright.

Strict: any key outside these four — subject in particular — is a 400 rather than a silently dropped field, because a caller trying to move a profile to another end user should be told it did not happen.

label
string | null

Yours, for bookkeeping. Never sent to a merchant. null clears it.

name
BuyerName · object | null

Also used as the cardholder name at the payment step, which is why the card action never asks for one.

contact
BuyerContact · object | null
shipping
BuyerShipping · object | null

Response

Updated. The full profile.

id
string<uuid>
required
label
string | null
required
subject
string | null
required

Your own id for the end user this profile belongs to, or null when it is not tagged to one. Always present — unlike a checkout, which omits the field entirely. Fixed at creation.

Example:

"user_a91f"

name
object | null
required

null when never supplied — not {}.

contact
object | null
required
shipping
object | null
required
createdAt
string<date-time>
required