Skip to main content
POST
Create Domain

Authorizations

Authorization
string
header
required

An account-scoped user token or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

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-10-15-1"

Body

application/json
domain
string
required

Bare hostname, such as example.com or checkout.example.com. A bought domain must be a root domain. Wildcards, paths, schemes, and ports are not accepted.

Example:

"store.example.com"

account_id
string

Account ID, prefixed biz_. Required for user credentials; otherwise defaults to the credential's account.

apple_pay
object | null

Accept Apple Pay at checkout on the domain. It needs no other capability. Whop registers the domain with Apple: it stays pending until Apple answers, then turns ready, or action_required when Apple couldn't fetch the domain association file. Serve the file, then check the domain to register it again. Pass null to turn Apple Pay off: Whop removes the domain from Apple, and the domain stays, like releasing any other capability.

email
object | null

Send and receive email on the domain. Only a domain bought through Whop, or a subdomain of one in the same account, can have it. Whop publishes the DNS records and stays pending until its email provider verifies them, then turns ready. Pass null to remove email.

metadata
object

Custom string keys and values.

Example:
pixel
object | null

Track page views on the domain with the Whop pixel. It needs no other capability: it stays pending until the pixel records a page view, and turns action_required if it goes 7 days without one. Pass null to stop tracking.

registration
object | null

Buy the domain through Whop, or transfer in a domain you own elsewhere with auth_code, then renew it every year and let Whop run its DNS. Pass null to release an unpaid or failed purchase, or to cancel a transfer while its current registrar can still stop it.

verification
object | null

Prove you control the domain's DNS: Whop returns a TXT record to publish in issues, and whoever publishes it owns the domain on Whop. Pass null to release it. Can't be combined with registration.

website
object | null

Serve a Whop website on the domain. Pass null to stop serving it; the domain keeps its other capabilities.

Response

Domain created

account_id
string | null
required

ID of the account the domain belongs to, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

apple_pay
object | null
required

Offering Apple Pay at checkouts served from the domain. null when not enrolled or not visible to you.

availability
object | null
required

Whether you can register the hostname and what it costs. Set only when no domain on Whop has it.

created_at
string | null
required

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

Example:

"2026-01-01T12:00:00.000Z"

domain
string
required

Normalized hostname, such as checkout.example.com.

Example:

"shop.com"

email
object | null
required

Sending and receiving email on the domain through Whop. null when not wanted, or when the domain belongs to an account you can't read.

id
string | null
required

Domain ID, prefixed dom_. null when no domain on Whop has this hostname.

Example:

"dom_xxxxxxxxxxxxxx"

issues
object[]
required
metadata
object
required

Custom string keys and values attached to this domain. Empty when the domain isn't yours.

Example:
owned_by
object | null
required

The account that has proven it owns this hostname on Whop, which can be your own. null when no account has.

pixel
object | null
required

Tracking page views on the domain with the Whop pixel. null when not tracked or not visible to you.

platform
object | null
required

An address on a zone Whop runs, such as example.whop.site, that follows its app's route. null for other domains or when not visible to you.

public_record
object | null
required

The domain's public registration record (RDAP), read when you retrieve it by hostname. null for domains on Whop, available domains, or a record that couldn't be read.

registration
object | null
required

Buying the domain through Whop, renewing it, and running its DNS. null when not wanted or not visible to you.

stats
object | null
required

Traffic on the domain. null when the domain isn't on Whop or isn't visible to you.

status
enum<string> | null
required

The most pressing state of the domain's capabilities: releasing, then action_required, then pending, then ready. idle when it wants nothing.

Available options:
idle,
pending,
ready,
action_required,
releasing,
null
Example:

"pending"

updated_at
string | null
required

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

Example:

"2026-01-01T12:00:00.000Z"

verification
object | null
required

Proving you control the domain's DNS with a TXT record. null when not wanted or not visible to you.

website
object | null
required

Serving a Whop website on the domain. null when not wanted.