Skip to main content
PATCH
Update Domain

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, 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

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-06-2"

Path Parameters

id
string
required

Domain ID, prefixed dom_. To retrieve, you can pass a hostname such as example.com instead; a bare name looks up .com.

Body

application/json
app_id
string | null

App ID, prefixed app_. Must belong to the same account. Pass null to detach a bought domain from its app; it keeps renewing.

auto_renew
boolean

For a bought domain, whether Whop charges its saved card to renew it before it expires.

metadata
object

Replacement custom string keys and values.

Example:
payment_method_id
string | null

For a bought domain, the saved card to charge, prefixed payt_. It must belong to the signed-in user. Pass null to remove it.

Response

Domain updated

account_id
string | null
required

ID of the account claiming or owning this domain, prefixed biz_. null for a search result.

Example:

"biz_xxxxxxxxxxxxxx"

amount_due
object | null
required

The charge the domain owes now. null when nothing is owed.

app_id
string | null
required

ID of the app the domain serves, prefixed app_. null for a search result or a bought domain without an app.

Example:

"app_xxxxxxxxxxxxxx"

auto_renew
boolean | null
required

Whether Whop charges the saved payment method to renew a bought domain before it expires. null for connected domains and search results.

Example:

true

created_at
string | null
required

When the domain was created, as an ISO 8601 timestamp. null for a search result.

Example:

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

dns_records
object[]
required
domain
string
required

Normalized hostname, such as checkout.example.com.

Example:

"shop.com"

expires_at
string | null
required

When the registration of a bought domain expires unless renewed, as an ISO 8601 timestamp. null for connected domains and search results.

Example:

null

id
string | null
required

Domain ID, prefixed dom_. null for a search result.

Example:

"dom_xxxxxxxxxxxxxx"

issues
object[]
required
metadata
object
required

Custom string keys and values attached to this domain. Empty for a search result.

Example:
mode
enum<string> | null
required

managed for a domain bought and renewed through Whop; external for a domain registered elsewhere and connected with DNS records. null for a search result.

Available options:
external,
managed,
null
Example:

"managed"

payment_method_id
string | null
required

ID of the saved card charged for a bought domain, prefixed payt_. null when none is set.

Example:

null

public_record
object | null
required

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

purchase_url
string | null
required

Link to pay the charge the domain owes now: its registration, or a yearly renewal. null when nothing is owed.

Example:

"https://whop.com/checkout/ch_xxxxxxxxxxxxxx/"

registration_quote
object | null
required

Whether you can register the domain and what it costs. Set for search results and hostname lookups; null for your own domains.

status
enum<string> | null
required

Domain lifecycle. Only active domains serve their app. null for a search result.

Available options:
pending_verification,
awaiting_payment,
registering,
provisioning,
active,
action_required,
deleting,
expired,
failed,
removed,
null
Example:

"awaiting_payment"

updated_at
string | null
required

When the domain was last updated, as an ISO 8601 timestamp. null for a search result.

Example:

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

verification_expires_at
string | null
required

When an unverified claim is automatically deleted, 48 hours after creation, as an ISO 8601 timestamp.

Example:

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