Skip to main content
POST
Create a payer profile
Add shipping addresses and payment methods to it next.
  • A Business account makes one per end user, named by your own external_user_id, which is never an email address.
  • A Personal account has one, with no external_user_id.
  • A paying run fills the tool’s payer inputs it leaves out from the profile.
  • Callers: an API key, an MCP OAuth token or a Dashboard session.
  • Permission: runs:create.
  • Effect: Creates or changes something.
  • Errors: payer_profile_exists, and the errors any request can get.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
external_user_id
string
name
string

a string at most 200 character(s) long

Required string length: 1 - 200
given_name
string

a string at most 100 character(s) long

Required string length: 1 - 100
family_name
string

a string at most 100 character(s) long

Required string length: 1 - 100
email
string

an email address

Required string length: 1 - 254
Pattern: ^[^\s@]+@[^\s@]+$
phone
string

a phone number, at most 40 characters

Required string length: 1 - 40
billing_address
object

Response

The new payer profile

id
string
required

payer_ and 32 lowercase hex digits

Pattern: ^payer_[0-9a-f]{32}$
external_user_id
string | null
required

The end user's ID in a Business account; null for a Personal account's profile

name
string | null
required
given_name
string | null
required
family_name
string | null
required
email
string | null
required
phone
string | null
required
billing_address
object | null
required
addresses
object[]
required

Its shipping addresses, oldest first

created_at
string
required

a string to be decoded into a Date

updated_at
string
required

a string to be decoded into a Date