Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-05-1"

Body

application/json
hostname
string
required

Hostname to register (e.g. checkout.example.com).

account_id
string

Account to register the domain for (biz_ tag). Defaults to the caller's account.

Response

domain registered as pending when verification fails

account_id
string | null
required

ID of the account the domain is registered for, prefixed biz_.

created_at
string
required

When the domain was created, as an ISO 8601 timestamp.

hostname
string
required

Hostname the checkout is served from (e.g. checkout.example.com).

id
string
required

Payment method domain ID, prefixed pmd_.

provider
enum<string>
required

Wallet provider the domain is registered with.

Available options:
apple
Example:

"apple"

status
enum<string>
required

Verification status. pending means the provider could not fetch the domain-association file yet; only verified domains show wallet payment methods at checkout.

Available options:
pending,
verified
Example:

"pending"

updated_at
string
required

When the domain was last updated, as an ISO 8601 timestamp.